Metrics

Here are the complete reference details for all metrics for the v3 Analytics Reporting API.

Metrics are specified with the metrics= query string parameter. Multiple values must be comma-separated with no spaces.

To retrieve a specific metric, specify it as in the following examples:

• metrics=plays_requested
• metrics=uniq_plays_requested
• metrics=displays,uniq_displays

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.

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

Unique Users

You may want to measure the number of unique users. To measure unique users, use the uniq_plays_requested metric described below. The Ooyala mobile SDKs generate and store a random unique ID which is application-specific. In other environments, a unique user is identified by local storage or cookie. If a user clears their browser cache, that user/device's ID will get regenerated next time they watch video. The generated IDs are completely random and don't include any user-identifiable information. When such information is not available for a user, a new unique identifier will be created for that user. We de-duplicate when calculating the number of unique users over time. For example, day 1 has users A, B, C; day 2 has users B, E., then when you pick date range = day 1 and day 2, then total unique users = 4 (A, B, C, E), Daily Avg. Unique Users = (3+2) / 2 = 3 (2.5 is converted to the closed integer).

Video and Engagement-Related Metrics

Discovery Insights Metrics

Other Metrics and Their Related Reports