get_video_engagement

Gets detailed engagement data on a single video. Note that video IDs must be used in the player to identify videos in order to use this method. This includes both completion metrics, plus the number of views for each second of the video.

Explorer

Explore this method

Request URL

http://api.tubemogul.com/api/v3/

HTTP method

GET

Arguments

Note one of the following must be provided.

scope (string)

The scope of the method being called. Valid values are tracker or publisher.

id (string)

The ID corresponding to the scope of the report.

start (string)

The start date for the report. Format is YYYY-MM-DD.

end (string)

The end date for the report. Format is YYYY-MM-DD.

site_id (string) — Optional

The ID for your site. This is required for publisher-scoped queries but not for trackers. Contact us if you do not know your site_id.

ip_video_id (string) — Optional

The InPlay (TubeMogul-assigned) identifier provided for this video. This is unique for every distinct video, and will not change over time.

video_id (string) — Optional

The identifier provided for this video in the video player. This must be unique for every distinct video, and must not change over time.

Response Parameters

ip_video_id (string)

The InPlay (TubeMogul-assigned) identifier provided for this video. This is unique for every distinct video, and will not change over time.

video_id (string)

The identifier provided for this video in the video player. This must be unique for every distinct video, and must not change over time.

display_name (string)

The display name provided for this video in the video player.

url (string)

The URL of the video file.

publisher_id (string)

The identifier provided for the publisher of this video in the video player. This must be unique for every distinct video, and must not change over time.

views (integer)

The number of times the video was viewed. A view is defined as when the video is actually played, i.e. when play is called on the Flash video object.

viewed_minutes (integer)

The total viewed minutes for this video.

pct_completions_50 (number)

The percentage of views that watched at least 50% of the video.

pct_completions_75 (number)

The percentage of views that watched at least 75% of the video.

pct_completions_100 (number)

The percentage of views that watched at least 100% of the video.

details (list)

A list of views for each second of the video. Note that if a dim parameter is specified, the views per second is not filtered. These filters will only apply to the other statistics in the response. Otherwise, entries will scoped based on the arguments provided in the request.

Example Response

http://api.tubemogul.com/api/v3?date=1230109922&user_id=123456
&scope=tracker&id=TD-PEX-222&video_id=45800160&method=get_video_engagement
&interval=perday&start=2008-12-10&end=2008-12-31&index=1&max_results=20
&auth=aa6fb416b3cac7861be9c9db2ebeef564b70f2e4

<response name="get_video_engagement" status="ok">
  <ip_video_id>ZSwU3y08aVxUBrkMTlej</ip_video_id>
  video_id>45800160</video_id>
  <display_name>
    My first really cool video
  </display_name>
  <url>
    http://myvideosite.com/RD08243_51796640.flv
  </url>
  <publisher_id>5438134</publisher_id>
  <views>176441</views>
  <viewed_minutes>68693</viewed_minutes>
  <pct_completions_50>14.78</pct_completions_50>
  <pct_completions_75>9.55</pct_completions_75>
  <pct_completions_100>5.55</pct_completions_100>
  <details has_more_items="true" list_size="119" count="20">
    <entry>
      <second>1</second>
      <views>130858</views>
    </entry>
    ...
    <entry>
      <second>20</second>
      <views>49319</views>
    </entry>
  </details>
</response>