get_search_terms

Gets the search terms associated with a given tracker. 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.
engine (string) — Optional
The search engine used. Valid values include: all, google, yahoo, msn, blinkx, truveo. Defaults to all.
sort (string) — Optional
The sort order of the list. Valid values include: views, viewed_minutes, search_term. Defaults to views.
.
filter (string) — Optional
A free-form filter to apply to the list. The search terms 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 search terms that were used when a search engine was the source of the traffic referral, with the following parameters for each. The entries will scoped based on the arguments provided in the request.
search_term (string)
The search term that was used.
views (integer)
The number of times all videos that were found using this search term 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 that used this search term to find the video.

Example Response

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

<response name="get_search_terms" status="ok">
  <views>3315111</views>
  <viewed_minutes>7514769</viewed_minutes>
  <details has_more_items="true" list_size="69179" count="20">
    <entry>
      <search_term>2012 END OF THE WORLD</search_term>
      <views>367</views>
      <viewed_minutes>857</viewed_minutes>
    </entry>
    ...
    <entry>
      <search_term>BURJ DUBAI</search_term>
      <views>93</views>
      <viewed_minutes>356</viewed_minutes>
    </entry>
  </details>
</response>

Error Codes

Standard error codes