Sign in

Run an analytics query

Runs a query against a versioned analytics catalog model and returns a columnar table. Totals queries (no dimensions) return exactly one row. Grouped, dimension-ordered queries may paginate with an opaque cursor.

post/api/v1/analytics/query

Headers

x-request-idstring

Optional caller-supplied request ID. Values must contain 1–64 ASCII letters, digits, or ._:/=-; invalid values are replaced with a generated UUID.

Request body

model'agent_runs' | 'agent_user_activity' required

Catalog model name. The current catalog supports agent_runs and agent_user_activity.

metricsstring[] required

Unique catalog metric names to select.

dimensionsstring[]

Unique catalog dimensions to group by.

limitinteger

Maximum rows returned per page.

cursorstring

Opaque continuation cursor from a previous grouped response. Not accepted on totals or metric-ordered queries.

Response

Columnar query results.

queryIdstring uuid required

Unique identifier for this execution.

catalogVersionstring required

Catalog version used to produce this response.

asOfstring date-time required

Inclusion boundary used for this response and any cursor continuation.

cursorstring nullable required

Continuation cursor for the next page, or null when there is no next page.

Changes