get_bandwidth_usage

Gets bandwidth utilization for a given tracker. This includes statistics aggregated over the specified timeframe, plus optional per-day, week or month totals.

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.

interval (string) — Optional

Determines the granularity of list values in the detailed response list. Valid values include perday or none. A value of none will omit the detail list. Defaults to none.

Response Parameters

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.

bandwidth_delivered (integer)

Total GB of video and audio data delivered as measured from the client. This statistic removes browser cached files from the calculation.

bandwidth_wasted (integer)

The GB downloaded due to progressive download of video content, but never were viewed. It represents the bandwidth that is paid for but never actually used. A pure streaming environment will not have any wasted bandwidth.

bandwidth_per_stream_avg (number)

The average MB used per stream, calculated by determining the amount of downloaded bandwidth per stream and then averaging across all streams.

details (list)

A list of per-day bandwidth utilization (above parameters). 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-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_bandwidth_usage" status="ok">
  <views>1910754</views>
  <bandwidth_delivered>22151.32</bandwidth_delivered>
  <bandwidth_wasted>8753.81</bandwidth_wasted>
  <bandwidth_per_stream_avg>11.57</bandwidth_per_stream_avg>
  <details interval="perday" has_more_items="true" list_size="22" count="20">
    <entry>
      <date>2008-12-10</date>
      <views>74556</views>
      <bandwidth_delivered>1145.12</bandwidth_delivered>
      <bandwidth_wasted>433.23</bandwidth_wasted>
      <bandwidth_per_stream_avg>15.32</bandwidth_per_stream_avg>
    </entry>
    ...
    <entry>
      <date>2008-12-29</date>
      <views>77749</views>
      <bandwidth_delivered>859.34</bandwidth_delivered>
      <bandwidth_wasted>397.73</bandwidth_wasted>
      <bandwidth_per_stream_avg>11.03</bandwidth_per_stream_avg>
    </entry>
  </details>
</response>

Error Codes

Standard error codes