get_traffic_sources

Gets the traffic sources associated with a given tracker or publisher. This includes basic statistics aggregated over the specified timeframe.

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.
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. The site_id must also be specified if using this parameter. This will scope the response to include stats for this video only.
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. This will scope the response to include stats for this video only.
sort (string) — Optional
The sort order of the list. Valid values include: views, viewed_minutes, traffic_source. Defaults to views.
filter (string) — Optional
A free-form filter to apply to the list. The referring domain will be searched for a case-insensitive match of the provided string.

Response Parameters

views (integer)
The number of views over the specified date range. 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 over the specified date range.
details (list)
A list of traffic sources (referring sites) with the following parameters for each. The entries will scoped based on the arguments provided in the request.
traffic_source (string)
The traffic source, or referring site.
views (integer)
The number of times all videos from this traffic source were viewed. A view is defined as when the video is actually played, i.e. when play is called on the video object.
viewed_minutes (integer)
The total viewed minutes for all videos from this traffic source.

Example Response

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

<response name="get_traffic_sources" status="ok">
  <views>3315111</views>
  <viewed_minutes>7514769</viewed_minutes>
  <details has_more_items="true" list_size="7713" count="20">
    <entry>
      <traffic_source>google</traffic_source>
      <views>1597475</views>
      <viewed_minutes>4492273</viewed_minutes>
    </entry>
    ...
    <entry>
      <traffic_source>facebook</traffic_source>
      <views>43380</views>
      <viewed_minutes>88533</viewed_minutes>
    </entry>
  </response>

Error Codes

Standard error codes