v13

OpenAPI 3.0.32026-07-31359869.4 MB

post/v2/observability/query

Request body

metricstring required

Metric id

scopeobject required

Owner or project scope for the query

aggregationstring

Aggregation function to apply. Some aggregations require a dimension: use <agg>/<dimension>, for example unique/visitor_id.

groupBystring[]

Dimensions to group results by. JSON dimensions support nested refs, for example event_data/checkout_step. Nested keys containing characters that OData cannot parse as an identifier, such as '-', spaces, quotes, or '/', must be wrapped in single quotes (escape embedded single quotes by doubling them), for example flags/'enable-comments-view' or event_data/'some property''s/value'.

filterstring

Filter to apply to the query. JSON dimensions support nested refs, for example event_data/checkout_step eq 'payment'. Nested keys containing characters that OData cannot parse as an identifier, such as '-', spaces, quotes, or '/', must be wrapped in single quotes (escape embedded single quotes by doubling them), for example flags/'enable-comments-view' eq true or event_data/'some property''s/value' eq true.

limitnumber

Maximum number of results

orderBystring

Rollup column to order grouped results by. Use the generated rollup key for the requested metric and aggregation. Defaults to the query engine count rollup.

orderDirection'asc' | 'desc'

Direction to order grouped results by. Defaults to desc.

granularityobject

Time bucket size

startTimestring

Start timestamp

endTimestring

End timestamp

bucketTimezonestring

IANA timezone (e.g. Europe/Paris) used only to align calendar buckets (1d/1mo) to that zone's day/month boundaries. startTime/endTime and all output timestamps are always UTC. No effect on sub-day granularities.

Response

object required