v3

latestOpenAPI 3.1.02026-08-0712650111.6 KB

Get Metric Breakdown Series

Per-value time series for the top-N values of a dimension — ONE scan.

Replaces the portal breakdown tables' per-row filtered /timeseries fan-out (2 GETs x N rows per table) with a single grouped query: GROUP BY (dimension, time bucket), restricted to the top-N dimension values via a joined subquery (same selection logic/ordering as /breakdown), so the window is scanned once — not once per value.

values[] (optional, <=100) overrides top-N selection with an explicit value list; the response then contains one entry per requested value in the given order, zero-filled when a value has no rows. The portal uses this to request series for exactly the rows its /breakdown call returned (whose top-N may have been computed over a different timeframe than the fixed 7d/30d sparkline windows).

Bucketing matches /timeseries exactly: same granularity auto-selection, same org-timezone day/hour keys, same gap-filling. Decomposable metrics use the two-level 15-minute-bin machinery; unique_viewers/median run a single-pass GROUP BY — per-(value, bucket) COUNT(DISTINCT) is exact because each bucket is contained within one group.

get/v1/metrics/{metric}/breakdown/series

Path parameters

metricstring required

Query parameters

dimensionstring required
measurementstring nullable
limitinteger
order_bystring

Response

Successful Response

{"stackTrail":"paths:/v1/metrics/{metric}/breakdown/series:get:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}