get_unique_viewers

Gets the number of unique viewers for a given tracker ID. 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.

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.

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

viewers (integer)

The total unique viewers over the specified date range. A unique viewer is identified by a Flash cookie, or by IP address if Flash cookies are disabled. If they same viewer shows up on multiple days in the specified date range, they are not counted multiple times.

daily_avg (integer)

The average number of unique viewers per day over the specified date range.

daily_max (integer)

The maximum number of unique viewers on any single day over the specified date range.

views_per_viewer (integer)

The total views for each unique viewer.

viewed_minutes_per_viewer (integer)

The number of viewed minutes per unique viewer.

details (list)

A list of per-day unique viewers with the following parameters: date and viewers. 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-229&method=get_unique_viewers&interval=perday
&start=2008-12-10&end=2008-12-31&index=1&max_results=20
&auth=aa6fb416b3cac7861be9c9db2ebeef564b70f2e4

<response name="get_unique_viewers" status="ok">
  <viewers>1350417</viewers>
  <daily_avg>61382</daily_avg>
  <daily_max>87990</daily_max>
  <views_per_viewer>1.98</views_per_viewer>   
  <viewed_minutes_per_viewer>8.07</viewed_minutes_per_viewer>
  <details interval="perday" has_more_items="true" list_size="22" count="20">
    <entry>
      <date>2008-12-10</date>
      <viewers>52197</viewers>
      <views_per_viewer>2.98</views_per_viewer>
      <viewed_minutes_per_viewer>3.07</viewed_minutes_per_viewer>
    </entry>
    ...
    <entry>
      <date>2008-12-29</date>
      <viewers>61105</viewers>
      <views_per_viewer>2.98</views_per_viewer>   
      <viewed_minutes_per_viewer>2.07</viewed_minutes_per_viewer>
    </entry>
  </details>
</response>

Error Codes

Standard error codes