Get Overall values

GET {{baseUrl}}/data/v1/metrics/:METRIC_ID/overall

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.

Request Params

Accepted formats are...

• array of epoch timestamps e.g. timeframe[]=1498867200&timeframe[]=1498953600
• duration string e.g. timeframe[]=24:hours or timeframe[]=7:days | | timeframe[] | string | | 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[] | string | | 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 | | filters[] | string | | 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[] | string | | 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, and views.

Example:

• metric_filters[]=aggregate_startup_time>=1000 | | metric_filters[] | string | | 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, and views.

Example:

• metric_filters[]=aggregate_startup_time>=1000 | | measurement | string | | Measurement for the provided metric. If omitted, the default for the metric will be used. |

HEADERS

RESPONSES

status: OK

{"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}}