Skip to Content
Mux Docs: Home
List breakdown values
get

List the breakdown values for a specific metric.

Request path & query params
METRIC_ID
string
Possible values: "aggregate_startup_time""downscale_percentage""exits_before_video_start""live_stream_latency""max_downscale_percentage""max_request_latency""max_upscale_percentage""page_load_time""playback_failure_percentage""playback_success_score""player_startup_time""playing_time""rebuffer_count""rebuffer_duration""rebuffer_frequency""rebuffer_percentage""request_latency""request_throughput""rebuffer_score""requests_for_first_preroll""seek_latency""startup_time_score""unique_viewers""upscale_percentage""video_quality_score""video_startup_preroll_load_time""video_startup_preroll_request_time""video_startup_time""viewer_experience_score""views""weighted_average_bitrate""video_startup_failure_percentage""ad_attempt_count""ad_break_count""ad_break_error_count""ad_break_error_percentage""ad_error_count""ad_error_percentage""ad_exit_before_start_count""ad_exit_before_start_percentage""ad_impression_count""ad_startup_error_count""ad_startup_error_percentage""playback_business_exception_percentage""video_startup_business_exception_percentage""view_content_startup_time""ad_preroll_startup_time""view_dropped_percentage"

ID of the Metric

group_by
string
Possible values: "asn""asset_id""browser""browser_version""cdn""continent_code""country""custom_1""custom_2""custom_3""custom_4""custom_5""custom_6""custom_7""custom_8""custom_9""custom_10""exit_before_video_start""experiment_name""live_stream_id""operating_system""operating_system_version""page_type""playback_failure""playback_business_exception""playback_id""player_autoplay""player_error_code""player_mux_plugin_name""player_mux_plugin_version""player_name""player_preload""player_remote_played""player_software""player_software_version""player_version""preroll_ad_asset_hostname""preroll_ad_tag_hostname""preroll_played""preroll_requested""region""source_hostname""source_type""stream_type""sub_property_id""video_content_type""video_encoding_variant""video_id""video_series""video_startup_business_exception""video_startup_failure""video_title""view_drm_type""view_has_ad""view_session_id""viewer_connection_type""viewer_device_category""viewer_device_manufacturer""viewer_device_model""viewer_device_name""viewer_user_id""ad_playback_failure""content_playback_failure""view_dropped""client_application_name""client_application_version""video_affiliate""viewer_plan""viewer_plan_status""viewer_plan_category""view_drm_level""video_brand""used_pip""time_shift_enabled""used_captions""video_codec""audio_codec""video_dynamic_range_type""view_cdn_edge_pop""view_cdn_origin""video_creator_id""video_cdn_trace"

Breakdown value to group the results by

measurement
string
Possible values: "95th""median""avg""count""sum"

Measurement for the provided metric. If omitted, the default for the metric will be used.
The default measurement for each metric is:
"sum" : ad_attempt_count, ad_break_count, ad_break_error_count, ad_error_count, ad_impression_count, playing_time
"median" : ad_preroll_startup_time, aggregate_startup_time, content_startup_time, max_downscale_percentage, max_upscale_percentage, page_load_time, player_average_live_latency, player_startup_time, rebuffer_count, rebuffer_duration, requests_for_first_preroll, video_startup_preroll_load_time, video_startup_preroll_request_time, video_startup_time, view_average_request_latency, view_average_request_throughput, view_max_request_latency, weighted_average_bitrate
"avg" : ad_break_error_percentage, ad_error_percentage, ad_exit_before_start_count, ad_exit_before_start_percentage, ad_playback_failure_percentage, ad_startup_error_count, ad_startup_error_percentage, content_playback_failure_percentage, downscale_percentage, exits_before_video_start, playback_business_exception_percentage, playback_failure_percentage, playback_success_score, rebuffer_frequency, rebuffer_percentage, seek_latency, smoothness_score, startup_time_score, upscale_percentage, video_quality_score, video_startup_business_exception_percentage, video_startup_failure_percentage, view_dropped_percentage, viewer_experience_score
"count" : started_views, unique_viewers

filters[]
array

Filter results using key:value pairs. Must be provided as an array query string parameter.

Basic filtering:

  • filters[]=dimension:value - Include rows where dimension equals value
  • filters[]=!dimension:value - Exclude rows where dimension equals value

For trace dimensions (like video_cdn_trace):

  • filters[]=+dimension:value - Include rows where trace contains value
  • filters[]=-dimension:value - Exclude rows where trace contains value
  • filters[]=dimension:[value1,value2] - Exact trace match

Examples:

  • filters[]=country:US - US views only
  • filters[]=+video_cdn_trace:fastly - Views using Fastly CDN
metric_filters[]
array

Limit the results to rows that match inequality conditions from provided metric comparison clauses. Must be provided as an array query string parameter.

Possible filterable metrics are the same as the set of metric ids, with the exceptions of exits_before_video_start, unique_viewers, video_startup_failure_percentage, view_dropped_percentage, and views.

Example:

  • metric_filters[]=aggregate_startup_time>=1000
limit
integer
(default: 25)

Number of items to include in the response

page
integer
(default: 1)

Offset by this many pages, of the size of limit

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.

timeframe[]
array

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

Accepted formats are...

  • array of epoch timestamps e.g. timeframe[]=1498867200&timeframe[]=1498953600
  • duration string e.g. timeframe[]=24:hours or timeframe[]=7:days
get
200
/data/v1/metrics/{METRIC_ID}/breakdown
Response
(application/json)
{
  "total_row_count": 1,
  "timeframe": [
    1610028298,
    1610114698
  ],
  "meta": {
    "aggregation": "view_end"
  },
  "data": [
    {
      "views": 5,
      "value": 4,
      "total_watch_time": 513934,
      "total_playing_time": 413934,
      "negative_impact": 1,
      "field": "US"
    }
  ]
}