(Deprecated) Common Attributes and Query String Parameters

These attributes and query string parameters are used by the Analytics routes.

Warning: The v2 Analytics API has been deprecated. See Ooyala IQ Analytics for more details on the new v3 Analytics API.

Route Attributes

The following table describes all attributes of the route.

Route Attribute Description
asset_id Specifies the ID of the asset.

Type: String

Default: None

Examples:

/v2/analytics/reports/asset/fjkl3s23fdsf2/engagement

city

Returns information cities.

Type: String

Default: Returns top ten cities.

Examples:

[GET] /v2/analytics/reports/account/performance/cities/2011-08-01...2011-08-08 (all cities)

[GET] /v2/analytics/reports/account/performance/countries/us/regions/california/cities/2011-08-01...2011-08-08 (all cities in California)

[GET] /v2/analytics/reports/account/performance/countries/us/regions/california/cities/san+francisco/2011-08-01...2011-08-08 (San Francisco only)

[GET] /v2/analytics/reports/asset/asset_id/performance/cities/2011-08-01...2011-08-08 (specified asset, all cities)

[GET] /v2/analytics/reports/asset/asset_id/performance/countries/us/regions/california/cities/2011-08-01...2011-08-08 (specified asset, all cities in California)

[GET] /v2/analytics/reports/asset/asset_id/performance/countries/us/regions/california/cities/san+francisco/2011-08-01...2011-08-08 (specified asset, San Francisco only)

country

Returns information about countries (not case-sensitive).

Type: String

Default: Returns top ten countries.

Valid Values: For a list of valid country codes, refer to the two-letter ISO 3166-1 country codes. For unknown countries, Backlot uses u0.

Examples:

[GET] /v2/analytics/reports/account/performance/countries/2011-08-01...2011-08-08 (all countries)

[GET] /v2/analytics/reports/account/performance/countries/us/2011-08-01...2011-08-08 (US only)

[GET] /v2/analytics/reports/asset/asset_id/performance/countries/2011-08-01...2011-08-08 (specified asset in all countries)

[GET] /v2/analytics/reports/asset/asset_id/performance/countries/us/2011-08-01...2011-08-08 (specified asset in US only)

date_range

Specifies the date range.

Type: String

Default: None

Examples:

[GET] /v2/analytics/reports/account/performance/regions/2012-01-01 (one day)

[GET] /v2/analytics/reports/account/performance/regions/2012-01-01...2012-01-02 (one day)

[GET] /v2/analytics/reports/account/performance/regions/2012-01-01...2012-01-08 (weekly)

[GET] /v2/analytics/reports/account/performance/regions/2012-01-01...2012-02-01 (monthly)

[GET] /v2/analytics/reports/account/performance/regions/2012-01-01...2012-04-01 (quarterly)

Note: The last date in the range is not included in the results.
devicetype

Returns information about device types.

Type: String

Valid Values: mobile | tablet | desktop | settop | unknown.devicetype

Default: None

Example: /analytics/reports/account/performance/device_types/tablet/2011-08-01...2011-08-08

dma

Returns information about designated marketing areas (DMAs).

Default: Returns top ten DMAs.

Examples:

[GET] /v2/analytics/reports/account/performance/dmas/2011-08-01...2011-08-08 (all DMAs)

[GET] /v2/analytics/reports/account/performance/dmas/new+york/2011-08-01...2011-08-08 (New York DMA)

[GET] /v2/analytics/reports/asset/asset_id/performance/dmas/2011-08-01...2011-08-08 (specified asset, all DMAs)

[GET] /v2/analytics/reports/asset/asset_id/performance/dmas/new+york/2011-08-01...2011-08-08 (specified asset, New York DMA)

domain

Returns information about domains.

Type: String

Default: Returns top ten domains.

Examples:

[GET] /v2/analytics/reports/account/performance/domains/2011-08-01...2011-08-08 (all domains)

[GET] /v2/analytics/reports/account/performance/domains/ooyala.com/2011-08-01...2011-08-08 (ooyala.com domain)

[GET] /v2/analytics/reports/asset/asset_id/performance/domains/2011-08-01...2011-08-08 (specified asset, all domains)

[GET] /v2/analytics/reports/asset/asset_id/performance/domains/ooyala.com/2011-08-01...2011-08-08 (specified asset, ooyala.com domain)

level

Specifies whether the report runs at the account or asset level. When you specify asset, you must provide an asset ID.

Type: String

Default: None

Valid Values: account | asset/asset_id

Examples:

[GET] /v2/analytics/reports/account/performance/total/2011-08-01...2011-08-08

[GET] /v2/analytics/reports/asset/fjkl3s23fdsf2/performance/total/2011-08-01...2011-08-08

platform

Returns information about platforms (device types, operating systems, and browsers).

Type: String

Default: None

Example:

[GET] /v2/analytics/reports/account/performance/platforms/2011-08-01...2011-08-08 (all platforms)

[GET] /v2/analytics/reports/account/performance/platforms/desktop:mac-chrome/2011-08-01...2011-08-08 (Macs running Chrome)

[GET] /v2/analytics/reports/asset/asset_id/performance/platforms/2011-08-01...2011-08-08 (specified asset, all platforms)

[GET] /v2/analytics/reports/asset/asset_id/performance/platforms/tablet:android-unknown.browser/2011-08-01...2011-08-08 (specified asset, iOS tablets)

[GET] /v2/analytics/reports/account/performance/device_types/desktop/platforms/2011-08-01...2011-08-08 (All desktop platforms)

region

Returns information about regions (e.g., states in the United States).

Type: String

Default: Returns top ten regions.

Examples:

[GET] /v2/analytics/reports/account/performance/regions/2011-08-01...2011-08-08 (all regions)

[GET] /v2/analytics/reports/account/performance/countries/us/regions/2011-08-01...2011-08-08 (all regions in the US)

[GET] /v2/analytics/reports/account/performance/countries/us/regions/california/2011-08-01...2011-08-08 (California only)

[GET] /v2/analytics/reports/asset/asset_id/performance/regions/2011-08-01...2011-08-08 (specified asset, all regions)

[GET] /v2/analytics/reports/asset/asset_id/performance/countries/us/regions/2011-08-01...2011-08-08 (specified asset, all regions in the US)

[GET] /v2/analytics/reports/asset/asset_id/performance/countries/us/regions/california/2011-08-01...2011-08-08 (specified asset, California only)

tag_id

The ID of the tag.

Type: String

Default: None

Example: /analytics/tags/extreme_couch_potato

url

Returns information about the specified URL.

Type: String

Default: Returns top ten URLs.

Example: /analytics/reports/account/performance/domains/ooyala.com/support

videos

Returns top videos.

Type: String

Default: 10

Example:

[GET] /v2/analytics/reports/account/performance/videos/2011-08-01...2011-08-08&limit=20

Query String Parameters

The following table describes the query string parameters of the routes.

Note: For clarity, the examples here are not URL-encoded; however, in actual practice, all query string parameters and values must be URL-encoded.
Parameter Description Required?
breakdown_by

Returns results by day, week, and or month instead of returning the metrics as a single value. This parameter is only supported when the dimension is total and there are no drilldowns.

Type: String

Valid Values: day | week | month

Default: day

Example: breakdown_by=month

No
limit

The maximum number of results to return. If you receive more results than the value you specify, you can get the next page of results with the paging token.

Type: Integer

Default: 10

Valid Values: 1-500

Example: limit=20

No
order_by

The field to sort on, in descending order. Any query sorted by plays, displays, or time watched will return up to 1000 results.

Type: String

Default: plays

Valid Values: plays | displays | time_watched | video_starts | ad_requests | ad_impressions | ad_clicks

Example: order_by=displays

No
paging_token

or

page_token
URL to the next page of results.
Note: If the number of results for a given page is divisible by the value of limit, the service returns a 404 response.

Type: String

Default: None

Example: [GET] /v2/analytics/reports/account/performance/videos/2012-01-01...2012-01-24?page_token=W1siY29sdW1uIiwiMzRTYUun1yJdLFsiaW5kZXgiLDEwXSxbInZhbHVlIiwxXV0=

No

Was this article helpful?