List Insights
GET {{baseUrl}}/data/v1/metrics/:METRIC_ID/insights
Returns a list of insights for a metric. These are the worst performing values across all breakdowns sorted by how much they negatively impact a specific metric.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
measurement | string | Measurement for the provided metric. If omitted, the default for the metric will be used. | |
order_direction | string | Sort order. | |
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| |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|
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"total_row_count":18,"timeframe":[1610029610,1610116010],"meta":{"aggregation":"view_end"},"data":[{"total_watch_time":351144,"total_playing_time":341144,"total_views":1,"negative_impact_score":-5,"metric":9,"filter_value":"","filter_column":"video_title"},{"total_watch_time":513934,"total_views":5,"negative_impact_score":0,"metric":4,"filter_value":"US","filter_column":"country"}]}