Dimensions

Lists elements for a trace dimension

Changed on

Lists the elements (values) for a trace dimension along with their total counts. This endpoint is specifically designed for trace dimensions like video_cdn_trace that contain arrays of values.

get/data/v1/dimensions/{DIMENSION_ID}/elements

Request

  • Base URL
    https://api.mux.com
  • Auth
    • HTTP basic
    • or HTTP bearer

Path parameters

DIMENSION_IDstring required

ID of the Dimension

Query parameters

limitinteger

Number of items to include in the response

pageinteger

Offset by this many pages, of the size of limit

filtersstring[]

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 value
  • filters[]=!dimension:value - Exclude rows where dimension equals value

For trace dimensions (like video_cdn_trace):

  • filters[]=+dimension:value - Include rows where trace contains value
  • filters[]=-dimension:value - Exclude rows where trace contains value
  • filters[]=dimension:[value1,value2] - Exact trace match

Examples:

  • filters[]=country:US - US views only
  • filters[]=+video_cdn_trace:fastly - Views using Fastly CDN
metric_filtersstring[]

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, view_dropped_percentage, and views.

Example:

  • metric_filters[]=aggregate_startup_time>=1000
timeframestring[]

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
order_by'negative_impact' | 'value' | 'views' | 'field'

Value to order the results by

order_direction'asc' | 'desc'

Sort order.

Response

OK

total_row_countinteger required
timeframeinteger[] required

Changes

    • warning

      deleted the query request parameter filters[]

    • warning

      deleted the query request parameter metric_filters[]

    • warning

      deleted the query request parameter timeframe[]

    • info

      added the new optional query request parameter filters

    • info

      added the new optional query request parameter metric_filters

    • info

      added the new optional query request parameter timeframe

    • info

      added the new optional query request parameter page