Dimensions

Here are the reference details for all predefined dimensions for the v3 Analytics Reporting API.

Dimensions are specified with the dimensions= query string parameter. Some considerations:
  • For time ranges up to 1 month you can query by up to 3 dimensions at a time with unlimited rows of data.
  • For time ranges greater than one month you can query by up to 2 dimensions at a time with up to 10,000 rows of data.
    Note: You can only use 1 dimension for url queries.
  • Multiple values must be comma-separated with no spaces.
  • The order of multiple is not important:
    • dimensions=device_type,dma is the same as dimensions=dma,device_type
Name Meaning Additional Info

asset

Video or other assets, including both Ooyala asset IDs (embed codes or content IDs) and external identifiers.

To query unlimited asset data with the API, in your query you must:
  1. Set a date range of less than or equal to 1 month (<32 days).
  2. Use dimensions=asset (with no additional dimensions).
  3. Set the page parameter (where page=X and X<= the last page).
  4. Set the limit parameter (where limit<=1000).

To filter the asset dimension by label, include the filter: filters=label=='yourLabelId'

Response also includes:
{ 
   embed_code,name,status,type
}
  • name is the title of the video.
  • embed_code is the video identifier (content ID or asset ID).
  • status is the video's status in Ooyala Backlot: live or paused.

country

Country code. See Country and Location Codes.

Response includes full country name.

In the Analytics UI, part of Geography.

region

Geographic region. Our geographic reporting uses the definition of region provided by Quova.

You cannot specify region alone; you must also specify its country.

In the Analytics UI, part of Geography.

dma

Defined marketing area (a US-centric concept not prominent in other parts of the world), specified by DMA ID.

Response includes DMA ID and a descriptive name. In the Analytics UI, part of Geography.
state State name. For example, if you drill down by Geo on the United States, you will see California, Arizona, etc. Our geographic reporting uses the definition of state provided by Quova (state is "the first-level administrative division" of a country).

You cannot specify state alone; you must also specify its country.

In the Analytics UI, part of Geography.

device_type

Device type.

See possible values in Codes for Platforms, Devices, and Operating Systems.

domain

Internet domain (fully qualified domain name).

In the Analytics UI, part of Traffic Source.

url

Uniform resource locator (URL).

Note: You can only use 1 dimension (url) for url queries. You can only apply url or domain filters for url queries.
In the Analytics UI, part of Traffic Source.

os

Operating system of the user's device. Must be exact string; partial matches not supported.

See possible values in Codes for Platforms, Devices, and Operating Systems.

browser

User's web browser.

Note: The browser dimension applies only when device_type is desktop.

See possible values in Codes for Platforms, Devices, and Operating Systems.

pcode

Ooyala-supplied provider ID.

player_id

The identifiers of Ooyala or other named video players used during playback.

Note: The Ooyala mobile SDKs (Android and iOS) currently do not send a player_id, so the player_id for the mobile SDKs is attributed as "unknown".

Was this article helpful?