get_geo_performance

Gets the delivery quality statistics for countries or regions for a given tracker ID. This includes basic statistics aggregated over the specified timeframe. A returned country 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.
detail (string) — Optional
Specifies the level of detail of the response. Valid values include: country, state. A value of region is invalid if video_id is specified. Defaults to country.

Response Parameters

details (list)
A list of videos with the following for each video. The entries will scoped based on the arguments provided in the request.
country (string)
The country where the views originated from.
country_code (string)
The ISO-3166 country code where the views originated from, with the addition of:
A1 for Anonymous Proxies. Does not include Open Proxy detection.
A2 for Satellite Providers
EU for Europe
AP for Asia/Pacific Region
In addition, we map overseas military bases to US
country_lat (number)
An approximate latitude value for the country.
country_long (number)
An approximate longitude value for the country.
state (string)
If detail=state or detail=city the state or region the views originated from. For US/Canada, this is the ISO-3166-2 code for the state/province name, with the addition of AA, AE, and AP for Armed Forces America, Europe and Pacific. Outside of the US and Canada the FIPS 10-4 number code is provided.
state_lat (number)
An approximate latitude value for the state.
state_long (number)
An approximate longitude value for the state.
views (integer)
The number of times all videos were viewed by this country or region. A view is defined as when the video is actually played, i.e. when play is called on the video object.
bandwidth_delivered (integer)
Total MB of video and audio data delivered as measured from the client. This statistic removes browser cached files from the calculation.
rebuffers (integer)
The number of streams downloaded that had one or more rebuffer events during playback.
rebuffers_pct (number)
The percentage of streams that had one or more rebuffer events during playback.
rebuffers_per_stream (number)
The average number of rebuffering events that occurred for each stream.
rebuffers_per_hour (number)
The average number of rebuffering events for each hour of play time.

Example Response

http://api-inplay.tubemogul.com/data/v2?date=1230109922&user_id=123456
&scope=tracker&id=TD-PEX-222&method=get_geo_performance&interval=perday
&start=2008-12-10&end=2008-12-31&index=1&max_results=20
&auth=aa6fb416b3cac7861be9c9db2ebeef564b70f2e4

<response name="get_geo_performance" status="ok">
  <details has_more_items="true" list_size="205" count="20">
    <entry>
      <country_code>US</country_code>
      <country>United States</country>
      <views>1281580</views>
      <bandwidth_delivered>13688.24</bandwidth_delivered>
      <bandwidth_per_stream_avg>10.62</bandwidth_per_stream_avg>
      <rebuffers>125184</rebuffers>
      <rebuffers_pct>9.77</rebuffers_pct>
      <rebuffers_per_stream>0.1</rebuffers_per_stream>
      <rebuffers_per_hour>351.65</rebuffers_per_hour>
    </entry>
    ...
    <entry>
      <country_code>DK</country_code>
	  <country>Denmark</country>
      <views>6561</views>
      <bandwidth_delivered>88.74</bandwidth_delivered>
      <bandwidth_per_stream_avg>13.52</bandwidth_per_stream_avg>
      <rebuffers>3893</rebuffers>
      <rebuffers_pct>59.34</rebuffers_pct>
      <rebuffers_per_stream>0.59</rebuffers_per_stream>
      <rebuffers_per_hour>2136.08</rebuffers_per_hour>
    </entry>
  </details>
</response>

Error Codes

Standard error codes