get_player_embeds

Gets the domains where the video player is being embedded associated with a given tracker or publisher. This includes basic statistics aggregated over the specified timeframe. The returned syndicator values 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. Valid values are tracker or publisher.
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, player_embeds. Defaults to views.
filter (string) — Optional
A free-form filter to apply to the list. The embed 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 domains where the player was embedded with the following parameters for each. The entries will scoped based on the arguments provided in the request.
domain (string)
The domain that has embedded the player.
views (integer)
The number of views that come from this domain. 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 number of viewed minutes that came from this domain.

Example Response

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

<response name="get_player_embeds" status="ok">
  <details has_more_items="true" list_size="391728" count="20">
    <entry>
      <domain>thatguywiththeglasses.com</domain>
      <views>937795</views>
      <viewed_minutes>8459249</viewed_minutes>
    </entry>
    ...
    <entry>
      <domain>www.purepwnage.com</domain>
      <views>132903</views>
      <viewed_minutes>1494278</viewed_minutes>
    </entry>
  </details>
</response>

Error Codes

Standard error codes