Skip to Content
Mux Docs: Home
Get Monitoring Breakdown
get

Gets breakdown information for a specific dimension and metric along with the number of concurrent viewers and negative impact score.

Request path & query params
MONITORING_METRIC_ID
string
Possible values: "current-concurrent-viewers""current-rebuffering-percentage""exits-before-video-start""playback-failure-percentage""current-average-bitrate""video-startup-failure-percentage"

ID of the Monitoring Metric

dimension
string
Possible values: "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

timestamp
integer

Timestamp to limit results by. This value must be provided as a unix timestamp. Defaults to the current unix timestamp.

filters[]
array

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
order_by
string
Possible values: "negative_impact""value""views""field"

Value to order the results by

order_direction
string
Possible values: "asc""desc"

Sort order.

get
200
/data/v1/monitoring/metrics/{MONITORING_METRIC_ID}/breakdown
Response
(application/json)
{
  "data": [
    {
      "concurrent_viewers": 2680,
      "metric_value": 0.008195679660675846,
      "negative_impact": 1,
      "value": "FR"
    },
    {
      "concurrent_viewers": 36,
      "metric_value": 0.010317417106767573,
      "negative_impact": 4,
      "value": "ES"
    },
    {
      "concurrent_viewers": 30,
      "metric_value": 0.06408818534303201,
      "negative_impact": 2,
      "value": "RE"
    },
    {
      "concurrent_viewers": 26,
      "metric_value": 0.008232510579858339,
      "negative_impact": 7,
      "value": "GB"
    },
    {
      "concurrent_viewers": 10,
      "metric_value": 0,
      "negative_impact": 26,
      "value": "BE"
    }
  ],
  "timeframe": [
    1610121421,
    1610121421
  ],
  "total_row_count": 1
}