After a GUID has been generated by the Create Queued Report endpoint, append the GUID to retrieve the finished report. Some reports may take longer periods to finish, so the report will also contain a status code.
Response Params
Property | Description |
|---|---|
| The GUID supplied in the request |
| An enum representing the status of the queued report, with the following values: |
| If |
| If |
Result Properties
Property | Description |
|---|---|
| If true, the report uses the Total time period |
| An internal Login ID used for generating the report |
| Deprecated |
| The time groupings (such as |
| Key/value pairs of the filters applied to the report. For example: |
| Deprecated |
| Deprecated |
| In the format of |
| In the format of |
| In the format of |
| In the format of |
| If test IP addresses have been added to click bucketing settings, the total number of clicks from those IPs |
| Total number of clicks originating from the same IP address |
| Total number of raw clicks, valid and invalid (i.e. no click bucketing) |
| Total number of clicks originating from suspicious sources (such as bots, etc.) |
| Total number of clicks originating from an invalid user agent |
| Total number of clicks originating from the same impression |
| Total number of clicks originating from a unique and valid source |
| Total number of clicks (as calculated without using click bucketing) |
| Total clickthrough rate (derived from |
| Total clickthrough rate (derived from |
| Total revenue. Deprecated in favor of |
| Total revenue |
| Total Gross Merchandise Value |
| Total Return On Ad Spend (derived from |
| Total eCPM |
| Total impressions |
| (BETA) Total requests for the placements. (Does not include Passback and RTB Requests) |
| (BETA) Number of times RTB partner(s) received a request AND a user was matched, regardless of whether they bid |
| (BETA) Number of times RTB partner(s) received a request, regardless of whether they bid |
| (BETA) Number of times Kevel received a bid from a RTB provider |
| (BETA) If an ad response includes an ad in an adChain priority, Passback Requests counts all the flights in the adChain considered for the selection |
| (BETA) |
| Deprecated |
| All additional (non-total) details of the report. Description of |
Records Array:
There is a unique object in the Records array per time period in the DateType. For example, a report with a 6 months time frame that is grouped by month will contain 6 objects in the Records array. This object is labeled by FirstDate and LastDate strings in the format YYYY-MM-DDTHH:MM:SS.
The object contains the same types of click and impression data etc. as the Total properties in the Result object. In addition, there is also an Events object that counts custom events by EventId.
Inside the object is a Details array. Each GroupBy in the report is broken out as a unique object in Details, including its own clicks and impressions pertinent to that GroupBy. The Grouping object inside that object states which GroupBy is being applied.
The example response has an example of Records, Details, and Grouping.
Conversions are represented in reports as Read-Only EventIds. Unlike other custom events, these EventIds can NOT be used to generate a tracking link in a Decision request.
1 = View Conversion
2 = Click Conversion
3 = Server Conversion
Using any of the following ID "GroupBy" dimensions: "flightId", "advertiserId", "campaignId", "publisherAccountId", "creativeId", "channelId", "priorityId", "adTypeId", "siteId", "zoneId"
will result in returning the corresponding name field e.g. "flightId"->"Flight" in Records[]->Details[]->Grouping, as in the example response.
Some fields in the example response, such as the request reporting fields, are additional features. Contact your account manager for more information.