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

General Syntax of Reporting GET

The base syntax of the route and query string is as follows. For ease of reading, the single-line request has been split across several lines.

[GET] /v3/analytics/reports/?
            report_type=type
            &dimensions=dimensions
            &metrics=metrics
            &filters=filter_type=='filter_value'
            &start_date=date
            &end_date=date
            &other_parms
            &api_key=your_api_key
         
  • The required query string parameters (shown in bold) are report_type, start_date, and api_key.
  • If no dimensions are specified, total values across all dimension are returned.
  • 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.
  • If no metrics are specified, all metrics are returned.
Note: You may pass the API key either as a query parameter or via the header X-API-KEY.
Note: At this time, the only valid value for report_type is performance.
Note: You can only use 1 dimension (url) for url queries.

General Syntax of Reporting Long Queries POST

For queries with query parameters that would exceed the HTTP GET specification limit of 230 characters , please use a POST request. Some browsers and http clients may support more than 230 characters, but we will not provide official support for queries that violate the HTTP GET specification. For POST requests, pass a JSON object in the request body instead of the query string parameters.

[POST] /v3/analytics/reports

{
    "report_type":"type",
    "dimensions":"dimensions",
    "metrics":"metrics",
    "filters":"(filter_type==\"filter_value\")",
    "start_date":"date",
    "end_date":"date",
    "other_parms":"other_param_value",
    "api_key":"your_api_key"
}
         
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,is_live_stream,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.
  • is_live_stream indicates whether the stream is live or video-on-demand (vod).

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".

해당 내용이 도움 되었습니까?