MUmuxinc
Metrics

List all metric values

Changed on

List all of the values across every breakdown for a specific metric.

get/data/v1/metrics/comparison

Request

  • Base URL
    https://api.mux.com
  • Auth
    • HTTP basic
    • or HTTP bearer

Query parameters

timeframestring[]

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
filtersstring[]

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_filtersstring[]

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
dimension'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' | 'page_url' | '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_failure' | 'video_startup_business_exception' | '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'

Dimension the specified value belongs to

valuestring

Value to show all available metrics for

Response

OK

total_row_countinteger nullable required
timeframeinteger[] required

Changes

  • 99c1d509dcbbRevision changes
    • warning

      deleted the query request parameter filters[]

    • warning

      deleted the query request parameter metric_filters[]

    • warning

      deleted the query request parameter timeframe[]

    • info

      added the new optional query request parameter filters

    • info

      added the new optional query request parameter metric_filters

    • info

      added the new optional query request parameter timeframe

  • 83dc80cce4d6Revision changes
    • info

      added the new enum value page_url to the query request parameter dimension