get_categories

Gets the categories associated with a given tracker ID. This includes basic statistics aggregated over the specified timeframe. A returned category value can be used in other method calls (where supported) as the dimdetail parameter.

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, category. Defaults to views.

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 categories with the following parameters for each. The entries will scoped based on the arguments provided in the request.
category (string)
The category being tracked.
views (integer)
The number of times all videos in this category 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 in this category.

Example Response

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

<response name="get_categories" status="ok">
  <views>3416687</views>
  <viewed_minutes>7779285</viewed_minutes>
  <details has_more_items="true" list_size="238" count="20">
    <entry>
      <category>NEWS</category>
      <views>906816</views>
      <viewed_minutes>1854289</viewed_minutes>
    </entry>
    ...
    <entry>
      <category>MUSIC</category>
      <views>317610</views>
      <viewed_minutes>530468</viewed_minutes>
    </entry>
  </response>

Error Codes

Standard error codes