get_video_list_analytics

Gets a list of videos using the specified sort order for a given tracker or publisher ID. This allows one to retrieve videos based on different "most popular" criteria.

Explorer

Explore this method

Request URL

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

HTTP method

GET

Arguments

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.
sort (string) — Optional: The sort order of the list. Valid values include: views, viewed_minutes. Defaults to views.
filter (string) — Optional: A free-form filter to apply to the list. The video URL, display_name, video_id and publisher_id fields will be searched for a case-insensitive match of the provided string.
ip_video_id (string) — Optional: A comma-separated list of up to 100 InPlay (TubeMogul-assigned) identifiers provided for this video. Each is unique for every distinct video, and will not change over time. This will scope the response to include stats for these videos only.
video_id (string) — Optional: A comma-separated list of up to 100 identifiers provided for this video in the video player. Each must be unique for every distinct video, and must not change over time. The site_id must also be specified if using this parameter. This will scope the response to include stats for these videos only.

Response Parameters

NOTE: The summary values do not reflect any scoping of the request from the ip_video_id, video_id or filter parameters.

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(s).
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 videos with the above parameters, plus the following for each video. The 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&method=get_video_list_analytics&interval=perday
&start=2008-12-10&end=2008-12-31&index=1&max_results=20
&auth=aa6fb416b3cac7861be9c9db2ebeef564b70f2e4

<response name="get_video_list_analytics" status="ok">
  <views>1910754</views>
  <viewed_minutes>3030821</viewed_minutes>
  <pct_completions_50>36.53</pct_completions_50>
  <pct_completions_75>31.15</pct_completions_75>
  <pct_completions_100>20.64</pct_completions_100>
  <details has_more_items="true" list_size="225719" count="20">
    <entry>
      <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>
    </entry>
    ...
    <entry>
      <ip_video_id>LPpwYKSYhlHniWCwEOPQ</ip_video_id>
	  <video_id>47762177</video_id>
	  <display_name>
        Your first really cool video
      </display_name>
      <url>
        http://myvideosite.com/PD22017_44601850.flv
      </url>
      <publisher_id>5616932</publisher_id>
      <views>11254</views>
      <viewed_minutes>5436</viewed_minutes>
      <pct_completions_50>23.7</pct_completions_50>
      <pct_completions_75>18.86</pct_completions_75>
      <pct_completions_100>13.76</pct_completions_100>
    </entry>
  </details>
</response>

Error Codes

Standard error codes