Returns the overall value for a specific metric, as well as the total view count, watch time, and the Mux Global metric value for the metric.
ID of the Metric
Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=).
Accepted formats are...
timeframe[]=1498867200&timeframe[]=1498953600
timeframe[]=24:hours or timeframe[]=7:days
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 valuefilters[]=!dimension:value
- Exclude rows where dimension equals valueFor trace dimensions (like video_cdn_trace):
filters[]=+dimension:value
- Include rows where trace contains valuefilters[]=-dimension:value
- Exclude rows where trace contains valuefilters[]=dimension:[value1,value2]
- Exact trace matchExamples:
filters[]=country:US
- US views onlyfilters[]=+video_cdn_trace:fastly
- Views using Fastly CDNLimit 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
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
{
"total_row_count": 1,
"timeframe": [
1610029525,
1610115925
],
"meta": {
"aggregation": "view_end"
},
"data": {
"value": 4,
"total_watch_time": 513934,
"total_playing_time": 413934,
"total_views": 5,
"global_value": 1169.1832095168065
}
}