Additional Info for Inplay Queries

The TubeMogul InPlay API allows third-party partners to retrieve detailed analytics collected from video players, either on their site, or if that data has been explicitly shared with the API user. Most methods are available on a per-tracker, per-publisher and per-video basis. There are additionally some administrative API functions.

Required Global Arguments for Inplay Queries

In addition to authentication variables, all Inplay queries use the following global variables.

NOTE: Unless otherwise denoted, strings are limited to 256 UTF-8 encoded characters.

The arguments listed below are required for every analytics or performance API method call, in addition to any arguments that are specific to the method:

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.

Optional Global Arguments

The arguments listed below are optional for analytics and performance API method calls:

dim (string)

Allows filtering by a specific category, player_embeds or country dimension.

dimdetail (string)

Required if a dimension is specified. This should correspond to a specific category, player_embeds or country value.

index (string)

Start index of the request when dealing with lists. Each response that contains a <details> list will contain <list_size> (of the complete list) and <has_more_items> elements. In addition, the <details> list contains a count attribute indicating how many items are in this page. Paging through lists is supported by providing an <index> to successive requests, which has been incremented by the count of the previous <details> list response. Defaults to 1.

max_results (string)

The maximum count value to be returned in a single response. Limited to 1000, and defaults to 50.

API Standard Error Codes

All methods can return the following status codes, in addition to per-method errors:

• 90 — Invalid parameter(s) or combination of parameters
• 93 — Invalid authentication hash
• 94 — Timestamp is more than 30 minutes old or is greater than the current time
• 97 — The method called was not found
• 99 — Invalid/unregistered partner.
• 999 — Unexpected error