Skip to Content
Mux Docs: Home
List all metric values
get

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

Request path & query params
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
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 Filters endpoint.

Example:

  • filters[]=operating_system:windows&filters[]=!country:US
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
dimension
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_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"

Dimension the specified value belongs to

value
string

Value to show all available metrics for

get
200
/data/v1/metrics/comparison
Response
(application/json)
{
  "total_row_count": 1,
  "timeframe": [
    1610029906,
    1610116306
  ],
  "data": [
    {
      "watch_time": 513934,
      "view_count": 5,
      "started_views": 6,
      "ended_views": 5,
      "unique_viewers": 6,
      "total_playing_time": 503934,
      "name": "totals"
    },
    {
      "value": 6,
      "type": "number",
      "name": "Views",
      "metric": "views",
      "items": [
        {
          "value": 6,
          "type": "number",
          "name": "Unique Viewers",
          "metric": "unique_viewers"
        },
        {
          "value": 503934,
          "type": "milliseconds",
          "name": "Playing Time",
          "metric": "playing_time"
        },
        {
          "value": 0,
          "type": "number",
          "name": "Ad Attempts (total)",
          "metric": "ad_attempt_count",
          "measurement": "avg"
        },
        {
          "value": 0,
          "type": "number",
          "name": "Ad Attempts (average)",
          "metric": "ad_attempt_count",
          "measurement": "avg"
        },
        {
          "value": 0,
          "type": "number",
          "name": "Ad Breaks (total)",
          "metric": "ad_break_count",
          "measurement": "avg"
        },
        {
          "value": 0,
          "type": "number",
          "name": "Ad Breaks (average)",
          "metric": "ad_break_count",
          "measurement": "avg"
        },
        {
          "value": 0,
          "type": "number",
          "name": "Ad Impressions (total)",
          "metric": "ad_impression_count",
          "measurement": "avg"
        },
        {
          "value": 0,
          "type": "number",
          "name": "Ad Impressions (average)",
          "metric": "ad_impression_count",
          "measurement": "avg"
        }
      ]
    },
    {
      "value": 0.7803472280502319,
      "type": "score",
      "name": "Overall Score",
      "metric": "viewer_experience_score"
    },
    {
      "value": 0.8,
      "type": "score",
      "name": "Playback Failure Score",
      "metric": "playback_failure_score",
      "items": [
        {
          "value": 0.2,
          "type": "percentage",
          "name": "Playback Failure Percentage",
          "metric": "playback_failure_percentage"
        },
        {
          "value": 0,
          "type": "percentage",
          "name": "Video Startup Failure Percentage",
          "metric": "video_startup_failure_percentage"
        },
        {
          "value": 0,
          "type": "percentage",
          "name": "Exits Before Video Start",
          "metric": "exits_before_video_start"
        },
        {
          "value": 0,
          "type": "percentage",
          "name": "View Dropped Percentage",
          "metric": "view_dropped_percentage"
        },
        {
          "value": 0,
          "type": "number",
          "name": "Ad Errors (total)",
          "metric": "ad_error_count",
          "measurement": "sum"
        },
        {
          "value": 0,
          "type": "number",
          "name": "Ad Errors (average)",
          "metric": "ad_error_count",
          "measurement": "avg"
        },
        {
          "value": 0,
          "type": "percentage",
          "name": "Ad Error Percentage (average)",
          "metric": "ad_error_percentage",
          "measurement": "avg"
        },
        {
          "value": 0,
          "type": "number",
          "name": "Ad Break Errors (total)",
          "metric": "ad_break_error_count",
          "measurement": "sum"
        },
        {
          "value": 0,
          "type": "number",
          "name": "Ad Break Errors (average)",
          "metric": "ad_break_error_count",
          "measurement": "avg"
        },
        {
          "value": 0,
          "type": "percentage",
          "name": "Ad Break Error Percentage (average)",
          "metric": "ad_break_error_percentage",
          "measurement": "avg"
        },
        {
          "value": 0,
          "type": "percentage",
          "name": "Ad Startup Error Percentage (average)",
          "metric": "ad_startup_error_percentage",
          "measurement": "avg"
        },
        {
          "value": 0,
          "type": "percentage",
          "name": "Ad Exit Before Start Percentage (average)",
          "metric": "ad_exit_before_start_percentage",
          "measurement": "avg"
        },
        {
          "value": 0,
          "type": "percentage",
          "name": "Playback Business Exception Percentage (average)",
          "metric": "playback_business_exception_percentage",
          "measurement": "avg"
        },
        {
          "value": 0,
          "type": "percentage",
          "name": "Video Startup Business Exception Percentage (average)",
          "metric": "video_startup_business_exception_percentage",
          "measurement": "avg"
        }
      ]
    },
    {
      "value": 0.9991008877754212,
      "type": "score",
      "name": "Startup Time Score",
      "metric": "startup_time_score",
      "items": [
        {
          "value": 4,
          "type": "milliseconds",
          "name": "Video Startup Time (median)",
          "metric": "video_startup_time",
          "measurement": "median"
        },
        {
          "value": 9,
          "type": "milliseconds",
          "name": "Video Startup Time (95th %)",
          "metric": "video_startup_time",
          "measurement": "95th"
        },
        {
          "value": 52.5625,
          "type": "milliseconds",
          "name": "Player Startup Time (median)",
          "metric": "player_startup_time",
          "measurement": "median"
        },
        {
          "value": 60.0625,
          "type": "milliseconds",
          "name": "Player Startup Time (95th %)",
          "metric": "player_startup_time",
          "measurement": "95th"
        },
        {
          "value": 122.37890625,
          "type": "milliseconds",
          "name": "Page Load Time (median)",
          "metric": "page_load_time",
          "measurement": "median"
        },
        {
          "value": 264.0625,
          "type": "milliseconds",
          "name": "Page Load Time (95th %)",
          "metric": "page_load_time",
          "measurement": "95th"
        },
        {
          "value": 182.25,
          "type": "milliseconds",
          "name": "Aggregate Startup Time (median)",
          "metric": "aggregate_startup_time",
          "measurement": "median"
        },
        {
          "value": 319.515625,
          "type": "milliseconds",
          "name": "Aggregate Startup Time (95th %)",
          "metric": "aggregate_startup_time",
          "measurement": "95th"
        },
        {
          "value": 3042,
          "type": "milliseconds",
          "name": "Seek Latency",
          "metric": "seek_latency"
        },
        {
          "value": 1000,
          "type": "milliseconds",
          "name": "Content Startup Time (median)",
          "metric": "view_content_startup_time",
          "measurement": "median"
        },
        {
          "value": 1403,
          "type": "milliseconds",
          "name": "Content Startup Time (95th %)",
          "metric": "view_content_startup_time",
          "measurement": "95th"
        },
        {
          "value": 800,
          "type": "milliseconds",
          "name": "Ad Preroll Startup Time (median)",
          "metric": "ad_preroll_startup_time",
          "measurement": "median"
        },
        {
          "value": 1243,
          "type": "milliseconds",
          "name": "Ad Preroll Startup Time (95th %)",
          "metric": "ad_preroll_startup_time",
          "measurement": "95th"
        }
      ]
    },
    {
      "value": 0.9523247838020324,
      "type": "score",
      "name": "Rebuffer Score",
      "metric": "rebuffer_score",
      "items": [
        {
          "value": 0.0005564916895943838,
          "type": "percentage",
          "name": "Rebuffer Percentage",
          "metric": "rebuffer_percentage"
        },
        {
          "value": 0.11674650830651406,
          "type": "per_minute",
          "name": "Rebuffer Frequency",
          "metric": "rebuffer_frequency"
        },
        {
          "value": 0,
          "type": "milliseconds",
          "name": "Rebuffer Duration (median)",
          "metric": "rebuffer_duration",
          "measurement": "median"
        },
        {
          "value": 256,
          "type": "milliseconds",
          "name": "Rebuffer Duration (95th %)",
          "metric": "rebuffer_duration",
          "measurement": "95th"
        },
        {
          "value": 0,
          "type": "number",
          "name": "Rebuffer Count (median)",
          "metric": "rebuffer_count",
          "measurement": "median"
        },
        {
          "value": 1,
          "type": "number",
          "name": "Rebuffer Count (95th %)",
          "metric": "rebuffer_count",
          "measurement": "95th"
        }
      ]
    },
    {
      "value": 1,
      "type": "score",
      "name": "Video Quality Score",
      "metric": "video_quality_score",
      "items": [
        {
          "value": 0,
          "type": "percentage",
          "name": "Upscale Percentage (median)",
          "metric": "upscale_percentage",
          "measurement": "median"
        },
        {
          "value": 0,
          "type": "percentage",
          "name": "Upscale Percentage (95th %)",
          "metric": "upscale_percentage",
          "measurement": "95th"
        },
        {
          "value": 0,
          "type": "percentage",
          "name": "Upscale Percentage (average)",
          "metric": "upscale_percentage",
          "measurement": "avg"
        },
        {
          "value": 0.007,
          "type": "percentage",
          "name": "Downscale Percentage (median)",
          "metric": "downscale_percentage",
          "measurement": "median"
        },
        {
          "value": 0.449,
          "type": "percentage",
          "name": "Downscale Percentage (95th %)",
          "metric": "downscale_percentage",
          "measurement": "95th"
        },
        {
          "value": 0.11813909473676262,
          "type": "percentage",
          "name": "Downscale Percentage (average)",
          "metric": "downscale_percentage",
          "measurement": "avg"
        },
        {
          "value": 0,
          "type": "percentage",
          "name": "Max Upscale Percentage (median)",
          "metric": "max_upscale_percentage",
          "measurement": "median"
        },
        {
          "value": 0,
          "type": "percentage",
          "name": "Max Upscale Percentage (95th %)",
          "metric": "max_upscale_percentage",
          "measurement": "95th"
        },
        {
          "value": 0.007,
          "type": "percentage",
          "name": "Max Downscale Percentage (median)",
          "metric": "max_downscale_percentage",
          "measurement": "median"
        },
        {
          "value": 0.449,
          "type": "percentage",
          "name": "Max Downscale Percentage (95th %)",
          "metric": "max_downscale_percentage",
          "measurement": "95th"
        },
        {
          "value": 851582.91015625,
          "type": "mbps",
          "name": "Weighted Average Bitrate (median)",
          "metric": "weighted_average_bitrate",
          "measurement": "median"
        },
        {
          "value": 697016.265625,
          "type": "mbps",
          "name": "Weighted Average Bitrate (95th %)",
          "metric": "weighted_average_bitrate",
          "measurement": "95th"
        },
        {
          "value": 2195,
          "type": "milliseconds",
          "name": "Live Stream Latency (median)",
          "metric": "live_stream_latency",
          "measurement": "median"
        },
        {
          "value": 3523,
          "type": "milliseconds",
          "name": "Live Stream Latency (95th %)",
          "metric": "live_stream_latency",
          "measurement": "95th"
        }
      ]
    }
  ]
}