Web API

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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
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*
string
required

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

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.

integer
≥ 0
Defaults to 0

Number of rows to skip before beginning to return rows.

integer
1 to 100000
Defaults to 100

Number of rows to return.

string
enum
Defaults to json

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

Allowed:
string
enum
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.

Allowed:
Responses

Updated 4 days ago

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 days ago