Fetch Real-time events

post https://{account}.piwik.pro/api/analytics/v1/real-time-events/

API that allows fetching raw Real-time events from the database.
Real-time data is retained for only an hour and may be available with a slight delay (up to a couple of minutes),
so we highly recommend getting the data older than 3 minutes (and newer than 60).

This API is not suitable for feeding external data warehouses as it is not a reliable source of complete data
- for that purpose we recommend regular Raw data API or Exports.

Please note that each request must be authenticated.

time	status	user agent
Retrieving recent requests…

Loading…

Body Params

website_id

uuid

required

ID of a website.

columns

array of objects

required

Definitions of additional columns that should be returned (timestamp and
identifiers will be returned by default).

columns*

date_from

string

required

Start datetime for the query (inclusive, in website's timezone).

date_to

string

required

End datetime for the query (exclusive, in website's timezone).

filters

object

Dimension filters for the query. The top-level object must specify
AND/OR clause, but any nested objects may either specify another AND/OR
clause or a single filter.

offset

integer

≥ 0

Defaults to 0

Number of rows to skip before beginning to return rows.

limit

integer

1 to 100000

Defaults to 100

Number of rows to return.

format

string

Defaults to json

Data format of a successful response (error responses are always in json).

column_format

string

Defaults to id

Format of the columns header (in CSV responses) and metadata labels
(in JSON responses). By default uses identifiers (id option), set to
name to use human-readable names.

Responses

Language

Credentials

OAuth2

URL


xxxxxxxxxx
15
1
curl --request POST \
2
     --url https://example.piwik.pro/api/analytics/v1/real-time-events/ \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "filters": {
8
    "operator": "and"
9
  },
10
  "offset": 0,
11
  "limit": 100,
12
  "format": "json",
13
  "column_format": "id"
14
}
15
'


xxxxxxxxxx
20
 
1
{
2
  "data": [
3
    [
4
      "2018-12-03T00:21:03",
5
      "375x667",
6
      [
7
        1,
8
        "Smartphone"
9
      ]
10
    ]
11
  ],
12
  "meta": {
13
    "columns": [
14
      "timestamp",
15
      "resolution",
16
      "device_type"
17
    ],
18
    "count": 3448
19
  }
20
}

Fetch Real-time events

Get the full experience

Analytics

200OK

400Bad Request

401Unauthorized

403Forbidden

Get the full experience

Analytics