Lists the values for a specific dimension

GET {{baseUrl}}/data/v1/dimensions/:DIMENSION_ID

Lists the values for a dimension along with a total count of related views.

Note: This API replaces the list-filter-values API call.

Request Params

KeyDatatypeRequiredDescription
limitnumberNumber of items to include in the response
pagenumberOffset by this many pages, of the size of limit
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 | | 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

{"data":[{"total_count":10000,"value":"FR"},{"total_count":5000,"value":"ES"},{"total_count":2000,"value":"PT"},{"total_count":100,"value":"DE"},{"total_count":1,"value":"BE"}],"timeframe":[1610033976,1610120376],"total_row_count":5}