List breakdown values

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

List the breakdown values for a specific metric.

Request Params

KeyDatatypeRequiredDescription
group_bystringBreakdown value to group the results by
measurementstringMeasurement for the provided metric. If omitted, the default for the metric will be used.
filters[]stringLimit 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 | | limit | number | | Number of items to include in the response | | page | number | | Offset by this many pages, of the size of limit | | order_by | string | | Value to order the results by | | 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 |

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{"total_row_count":1,"timeframe":[1610028298,1610114698],"meta":{"aggregation":"view_end"},"data":[{"views":5,"value":4,"total_watch_time":513934,"total_playing_time":413934,"negative_impact":1,"field":"US"}]}