GET data/v1/metrics/{METRIC_ID}/breakdown

mux.com

Summary: List breakdown values
Operation ID: list-breakdown-values
Auth: unknown
Description

List the breakdown values for a specific metric.

Parameters (9)

METRIC_ID (string, path, required)

ID of the Metric

Constraints: {'enum': ['aggregate_startup_time', 'downscale_percentage', 'exits_before_video_start', 'live_stream_latency', 'max_downscale_percentage', 'max_upscale_percentage', 'page_load_time', 'playback_failure_percentage', 'playback_failure_score', 'player_startup_time', 'playing_time', 'rebuffer_count', 'rebuffer_duration', 'rebuffer_frequency', 'rebuffer_percentage', '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']}

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 Filters endpoint. Example: * `filters[]=operating_system:windows&filters[]=!country:US`

group_by (string, query, optional)

Breakdown value to group the results by

Constraints: {'enum': ['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', '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_encoding_variant', 'video_id', 'video_series', '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']}

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

Number of items to include in the response

measurement (string, query, optional)

Measurement for the provided metric. If omitted, the default for the metric will be used.

Constraints: {'enum': ['95th', 'median', 'avg', 'count', 'sum']}

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']}

page (integer, query, optional, default: 1)

Offset by this many pages, of the size of `limit`

timeframe[] (array, query, optional)

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`

No probe data for this endpoint yet.