Working with Custom Analytics (Deprecated)

There are many types of user information that you might want to record, which are not available to Ooyala. This section provides an example of how to configure Backlot to record the gender of each viewer.

Warning: The v2 Analytics API has been deprecated. See Ooyala IQ Analytics for more details on the new v3 Analytics API.
To configure custom analytics, there essentially two steps:
  1. Creating the custom tags with the Analytics REST API
  2. Modifying your player creation code to send the custom tags when a player is created

This example deals with three custom tags. Every tag has an optional display name and can be managed via the APIs. When viewing the custom analytics in the Backlot the following format is presented: [display name] (Tag ID: [tag])

For example:
  • standard (Tag ID: standard)
  • custom widget (Tag ID: custom )
  • toolbar (Tag ID: toolbar)
  1. The following example creates a “standard”, “custom” and “toolbar” tags using Ooyala REST API.
  2. In your JavaScript, assign tag identifiers:
    var tags = new Array();
    /* Assign the correct value depending on the widget type*/
    if (widgetType == “standard”) tags[0] = “standard”;
    if (widgetType == “custom”) tags[0] = “custom”;
    if (widgetType == “toolbar”) tags[0] = “toolbar”;   
  3. Modify your play embeds to send the tags array when a player is created. The following is a basic example of a player V3 creation.
     window.player = OO.Player.create(playerID, embedCode, {
                            "tags": tags

Custom analytics are configured. You can begin viewing the results through the Backlot UI or Backlot API.