Skip to navigation

Get an organization analytics overview

When authenticated with an API key, this operation requires api-read. Use view=timeseries for grouped chart data: group_by and metric select series, limit selects top groups, and remaining groups form a null-key Other series. Missing group/bucket combinations are zero; tool-call grouping can count a request more than once.

Authentication

AuthorizationBearer
Console user session, Mixlayer API key, or Mixlayer workload access token supplied as a Bearer token.

Path parameters

org_idstringRequired
Organization ID

Query parameters

range_startlongRequired>=1

Inclusive Unix timestamp in milliseconds; must be greater than zero.

range_endlongRequired>=1

Exclusive Unix timestamp in milliseconds; must be greater than range_start.

group_byenumRequired
Breakdown dimension.
metricenumRequired
Breakdown metric.
bucketsintegerOptional>=0
Timeseries bucket count, clamped to 1 through 1000. When omitted, the range determines a default of 60, 72, or 96 buckets.
viewenumOptional

Response view; defaults to overview. Timeseries returns grouped chart data only.

Allowed values:
limitintegerOptional>=0
Top groups for the timeseries view. defaults to 5. 12 is max.
flist of stringsOptional

Repeated filters in [!]<dimension>:<value> form.

Response

Analytics overview
dataobject

Overview defaults to the full response; view=timeseries returns only grouped chart data.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error
503
Service Unavailable Error