API ReferenceBeta Analytics

Query analytics data

Execute an analytics query with specified metrics, dimensions, filters, and time range. Management key required.

Authentication

AuthorizationBearer
API key as bearer token in Authorization header

Request

This endpoint expects an object.
metricslist of stringsRequired
dimensionslist of stringsOptional
filterslist of objectsOptional
granularitystringOptional
Time granularity
group_limitintegerOptional

Maximum rows per distinct combination of dimensions (ClickHouse LIMIT n BY). When omitted on time-series queries (granularity + dimensions), auto-computed to avoid truncating time windows. Explicit values override the default and may truncate time buckets if set lower than the number of buckets in the range. Ignored when no dimensions are specified.

limitintegerOptional

Maximum total rows returned. Defaults to 1000. On time-series queries with dimensions and no explicit group_limit, the server may raise this to accommodate the expected number of unique time-bucket/dimension combinations.

order_byobjectOptional
time_rangeobjectOptional

Response

Analytics query results
dataobject

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
408
Request Timeout Error
500
Internal Server Error