Analytics

Based on your account, different analytics packages are available.

The following are the currently offered Ooyala account packages:

  • Custom Analytics Package—Custom Analytics
  • Default Analytics Package—Totals, Videos, Engagement, Sharing
  • Device Types Analytics Package—Device types, Platforms
  • Domain Analytics Package—Domains, URLs
  • Geo Analytics Package—Countries, Regions, Cities, DMAs

All packages are discussed here.

Generalized Syntax

With only one exception, all API requests for Analytics use the GET method, because you are only reading data, not writing it. (The one exception is Custom Analytics to create your own custom tags for tracking; see Custom Analytics: Tags.)

Thus, directly on the GET request, you specify various levels of detail, various types of data, or various constraints. On the route there are either attributes or query string parameters or both:
[GET] /v2/analytics/reports/attributes_suchas_levels_geo_andsoforth[/optional_attributes]?query_string_parms

As a result, the routes themselves can appear long or verbose but because of their verbosity, the meaning of the routes is clear.

In the syntax for the analytics routes, in the notation [/optional_qualifiers] the square brackets indicate that the attrubte is optional; their are not part of the real syntax.

  • Considerations about the Analytics API
    Be aware of some notable points about the Analytics API, including differences between the analytics in the Backlot UI and the API.
  • Displays, Plays, and Play Starts
    Ooyala Player usage is subdivided by events for displays, plays, and plays starts.
  • Performance
    The asset performance report shows comprehensive performance at the account or asset level.
  • Sharing
    The sharing report shows the number of share actions (e.g., Facebook, Twitter) for all content within your account or for an individual asset.
  • Engagement
    The engagement report displays the number of viewers as a video plays, which enables you to locate points where viewers lose interest, discover the effects of advertising placement, and assess its overall effectiveness.
  • Delivery
    The delivery report returns the number of bytes delivered for all content within your account or for an individual asset.
  • Custom Analytics: Tags
    Tags enable you to inject custom information into Ooyala analytics that you can use to create custom reports.
  • Custom Analytics: Reporting
    The custom analytics report shows performance information for tags that you configured.
  • Common Attributes and Query String Parameters
    These attributes and query string parameters are used by the Analytics routes.
Parent topic: Backlot API Reference

Download PDF Ooyala Developer Documentation

You are here

Home › Documentation › Backlot API Reference ›