Web API

Execute Real-time query

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

API that allows querying the Real-time database directly. 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 or a meta site.

columns
array of objects
required

Column definitions for the query.

columns*
integer
required

Period of time (in minutes) to query. Example: lookback_window=10 means "last 10 minutes of data".

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.

metric_filters
object

Metric 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.

order_by
array of arrays

Array of sorting directives. Each directive is a 2-element array with 0-based colum index and direction). You can sort on more than one column. By default sorts descending by the first metric in query.

order_by
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:
options
object

Additional options for query.

Responses

Updated 7 months 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 7 months ago