Engagement (Deprecated)

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.

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

Get Engagement Analytics (Videos)

[GET]/v2/analytics/reports/asset/asset_id/engagement/total/date_range

Get Engagement Analytics (Geo)

[GET]/v2/analytics/reports/asset/asset_id/engagement/countries[/country]/date_range
[GET]/v2/analytics/reports/asset/asset_id/engagement/regions/date_range
[GET]/v2/analytics/reports/asset/asset_id/engagement/cities/date_range
[GET]/v2/analytics/reports/asset/asset_id/engagement/countries/country/regions[/region]/date_range
[GET]/v2/analytics/reports/asset/asset_id/engagement/countries/country/regions/region/cities[/city]/date_range
[GET]/v2/analytics/reports/asset/asset_id/engagement/dmas[/dma]/date_range

Get Engagement Analytics (Domains and URLs)

[GET]/v2/analytics/reports/asset/asset_id/engagement/domains[/domain]/date_range
[GET]/v2/analytics/reports/asset/asset_id/engagement/domains/domain/urls[/url]/date_range
[GET]/v2/analytics/reports/asset/asset_id/engagement/urls[/url]/date_range

Get Engagement Analytics (Platforms and Devices)

[GET]/v2/analytics/reports/asset/asset_id/engagement/device_types[/devicetype]/date_range
[GET]/v2/analytics/reports/asset/asset_id/engagement/device_types/devicetype/platforms[/platform]/date_range
[GET]/v2/analytics/reports/asset/asset_id/engagement/platforms[/platform]/date_range

Examples

This example returns the engagement data for the specified asset:

[GET]/v2/analytics/reports/asset/dmbHViOgvgZMqXtY40DWmh4DuW6Ie6I6/engagement/total/2011-09-01...2011-09-05

which returns a response similar to the following:

 {  
   "results":[  
      {  
         "id":"total",
         "metrics":{  
            "engagement":{  
               "segments_watched":[  
                  292,
                  272,
                  250,
                  230,
                  230,
                  211,
                  185,
                  165,
                  166,
                  155,
                  149,
                  139,
                  139,
                  134,
                  127,
                  120,
                  120,
                  118,
                  113,
                  110,
                  110,
                  108,
                  105,
                  95,
                  96,
                  91,
                  89,
                  85,
                  85,
                  86,
                  85,
                  80,
                  81,
                  81,
                  98,
                  77,
                  78,
                  79,
                  77,
                  105
               ],
               "percentage_watched":[  
                  305,
                  274,
                  251,
                  236,
                  232,
                  217,
                  191,
                  170,
                  169,
                  162,
                  153,
                  144,
                  143,
                  139,
                  131,
                  124,
                  123,
                  121,
                  116,
                  111,
                  111,
                  109,
                  106,
                  96,
                  96,
                  93,
                  91,
                  86,
                  85,
                  83,
                  80,
                  76,
                  76,
                  74,
                  72,
                  71,
                  70,
                  69,
                  67,
                  67
               ]
            }
         }
      }
   ]
}
Note:

Try out the code samples using your account credentials in the Ooyala Scratchpad. For information about using the Scratchpad, see Practice Making Requests with the Scratchpad. To launch the scratchpad, go to Ooyala API Scratchpad.

The segments_watched array describes how many viewers were watching the video at each 2 1/2 % segment. Each segment bucket is for 2 1/2 % of the content.

The percentage_watched array describes how many viewers watched the specified percentage of the video. In this example, 305 watched 0 - 2 1/2 % of the video and 67 viewers watched 97 1/2 - 100%. The percentage_watched result is not linear. Users who watched 50% of the video could have watched the first half, the second half, the 25% point to the 75% point, and so on.

Was this article helpful?