v31

latestOpenAPI 3.1.0raw.githubusercontent.com2026-05-28124212862.9 KB
Monitoring

Get Monitoring Breakdown Timeseries

Gets timeseries of breakdown information for a specific dimension and metric. Each datapoint in the response represents 5 seconds worth of data.

get/data/v1/monitoring/metrics/{MONITORING_METRIC_ID}/breakdown-timeseries

Path parameters

MONITORING_METRIC_ID'current-concurrent-viewers' | 'current-rebuffering-percentage' | 'exits-before-video-start' | 'playback-failure-percentage' | 'current-average-bitrate' | 'video-startup-failure-percentage' required

ID of the Monitoring Metric

Query parameters

dimension'asn' | 'cdn' | 'country' | 'operating_system' | 'player_name' | 'region' | 'stream_type' | 'sub_property_id' | 'video_series' | 'video_title' | 'view_has_ad'

Dimension the specified value belongs to

timeframe[]string[]

Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=).

The default for this is the last 60 seconds of available data. Timeframes larger than 10 minutes are not allowed, and must be within the last 24 hours.

filters[]string[]

Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter.

To exclude rows that match a certain condition, prepend a ! character to the dimension.

Possible filter names are the same as returned by the List Monitoring Dimensions endpoint.

Example:

  • filters[]=operating_system:windows&filters[]=!country:US
limitinteger

Number of items to include in each timestamp's value list.

The default is 10, and the maximum is 100.

order_by'negative_impact' | 'value' | 'views' | 'field'

Value to order the results by

order_direction'asc' | 'desc'

Sort order.

Response

OK

total_row_countinteger nullable required
timeframeinteger[] required