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

mux.com

Summary: Get Monitoring Breakdown Timeseries
Operation ID: get-monitoring-breakdown-timeseries
Auth: unknown
Description

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

Parameters (7)

MONITORING_METRIC_ID (string, path, required)

ID of the Monitoring Metric

Constraints: {'enum': ['current-concurrent-viewers', 'current-rebuffering-percentage', 'exits-before-video-start', 'playback-failure-percentage', 'current-average-bitrate', 'video-startup-failure-percentage']}

dimension (string, query, optional)

Dimension the specified value belongs to

Constraints: {'enum': ['asn', 'cdn', 'country', 'operating_system', 'player_name', 'region', 'stream_type', 'sub_property_id', 'video_series', 'video_title', 'view_has_ad']}

filters[] (array, query, optional)

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`

limit (integer, query, optional, default: 10)

Number of items to include in each timestamp's `value` list. The default is 10, and the maximum is 100.

order_by (string, query, optional)

Value to order the results by

Constraints: {'enum': ['negative_impact', 'value', 'views', 'field']}

order_direction (string, query, optional)

Sort order.

Constraints: {'enum': ['asc', 'desc']}

timeframe[] (array, query, optional)

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.

No probe data for this endpoint yet.