get_video_list_performance

Gets a list of videos using the specified sort order for a given tracker ID.

Explorer

Explore this method

Request URL

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

HTTP method

GET

Arguments

NOTE: dim values can not be specified.

scope (string)
The scope of the method being called. The only valid value is tracker.
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, bandwidth_delivered and rebuffers. Defaults to views.
filter (string) — Optional
A free-form filter to apply to the list. Both the video URL and Display Name will be searched for a case-insensitive match of the provided string.
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. This will scope the response to include stats for this video only.

Response Parameters

details (list)
A list of videos with the following for each video. The entries will scoped based on the arguments provided in the request.
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.
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.
views (integer)
The number of times the video(s) were 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).
bandwidth_delivered (integer)
Total GB of video and audio data delivered for this video as measured from the client. This statistic removes browser cached files from the calculation.
rebuffers (integer)
The number of streams downloaded that had one or more rebuffer events during playback.
rebuffers_pct (number)
The percentage of streams of this video that had one or more rebuffer events during playback.
rebuffers_per_stream (number)
The average number of rebuffering events that occurred for each stream of this video.

Example Response

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

<response name="get_video_list_performance" status="ok">
  <views>1910754</views>
  <viewed_minutes>3030821</viewed_minutes>
  <details has_more_items="true" list_size="225719" count="20">
    <entry>
      <publisher_id>5438134</publisher_id>
      <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>
      <views>176441</views>
      <viewed_minutes>68693</viewed_minutes>
      <bandwidth_delivered>646476</bandwidth_delivered>
      <rebuffers>125740</rebuffers>
      <rebuffers_pct>71.26</rebuffers_pct>
      <rebuffers_per_stream>0.71</rebuffers_per_stream>
    </entry>
    ...
    <entry>
      <publisher_id>5616932</publisher_id>
      <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>
      <views>11254</views>
      <viewed_minutes>5436</viewed_minutes>
      <bandwidth_delivered>34371</bandwidth_delivered>
      <rebuffers>2839</rebuffers>
      <rebuffers_pct>25.23</rebuffers_pct>
      <rebuffers_per_stream>0.25</rebuffers_per_stream>
    </entry>
  </details>
</response>

Error Codes

Standard error codes