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 |
|---|---|
Id(string) | The GUID supplied in the request. |
Status(integer) | An enum representing the status of the queued report, with the following values: 1 = In progress, 2 = Complete, 3 = Error, 4 = Too Large. |
Message(string) | If Status is Error, this will contain the error message, null. |
Result(report object) | If Status is Complete, this will contain the requested report. No Result property will be returned for other Statuses. Description of the Result is below. |
Result Properties
| Property | Description |
|---|---|
IsTotal(boolean) | If true, the report uses the Total time period. |
LoginId(integer) | An internal Login ID used for generating the report. |
Grouping(array) | The time groupings (such as month) and the GroupBys (such as siteId) of the report. |
Critiera (object) [sic] | Key/value pairs of the filters applied to the report. For example: [{"brandId": 12345}]. Please note - the field's name to the left is correct. It's accidentally misspelled. |
StartDateISO(string) | In the format of StartDateISO. |
StartDateISO(string) | In the format of YYYY-MM-DDTHH:MM:SS.0000000. |
EndDateISO(string) | In the format of EndDateISO. |
EndDateISO(string) | In the format of YYYY-MM-DDTHH:MM:SS.0000000. |
TotalTestBucketClicks(integer) | If test IP addresses have been added to click bucketing settings, the total number of clicks from those IPs. |
TotalDuplicateIPBucketClicks(integer) | Total number of clicks originating from the same IP address. |
TotalRawBucketClicks(integer) | Total number of raw clicks, valid and invalid (i.e. no click bucketing). |
TotalSupiciousBucketClicks(integer) | Total number of clicks originating from suspicious sources (such as bots, etc.). |
TotalInvalidUABucketClicks(integer) | Total number of clicks originating from an invalid user agent. |
TotalDuplicateImpressionBucketClicks(integer) | Total number of clicks originating from the same impression. |
TotalUniqueBucketClicks(integer) | Total number of clicks originating from a unique and valid source. |
TotalClicks(integer) | Total number of clicks (as calculated without using click bucketing). |
TotalCTR(float) | Total clickthrough rate (derived from TotalClicks). |
TotalCVR(float) | Total conversion rate (calculated using total server conversions). |
TotalUniqueCTR(float) | Total clickthrough rate (derived from TotalUniqueBucketClicks). |
TotalTrueRevenue(float) | Total TrueRevenue. [Deprecated] |
TotalRevenue(float) | Total Revenue |
TotalGMV(float) | Total Gross Merchandise Value. |
TotalROAS(float) | Total Return On Ad Spend (derived from TotalGMV and TotalRevenue). |
TotalECPM(float) | Total eCPM. |
TotalCPC(float) | Total cost per click. |
TotalUnfilteredImpressions(integer) | Total impressions. |
TotalImpressions(integer) | Total impressions that are considered valid (non-IVT). |
TotalInvalidUAImpressions(integer) | Total invalid impressions due to invalid User Agent. |
TotalRequests(integer) | Total Selection Requests. (Does not include Passback and RTB Requests). |
TotalDecisionRequests(integer) | Total ADRs (Ad Decision Requests). |
TotalRtbMatchedRequests(integer) | Number of times RTB partner(s) received a request AND a user was matched, regardless of whether they bid. |
TotalRtbRequests(integer) | Number of times RTB partner(s) received a request, regardless of whether they bid. |
TotalRtbBidRequests(integer) | Number of times Kevel received a bid from a RTB provider. |
TotalPassbackRequests(integer) | If an ad response includes an ad in an adChain priority, Passback Requests counts all the flights in the adChain considered for the selection. |
TotalFillRate(float) | TotalImpressions divided by TotalRequests as a percentage. |
TotalSameProductCategoryPurchases(integer) | Number of Same Product Category Conversions (event ID=3) |
TotalSameProductSkuPurchases(integer) | Number of Same Product Sku Conversions (event ID=3) |
TotalSameProductBrandPurchases(integer) | Number of Same Product Brand Conversions (event ID=3) |
TotalD14Purchases(integer) | Number of Conversions (event ID=3) that happened within 14 days of attribution |
TotalD1Purchases(integer) | Number of Conversions (event ID=3) that happened within 24hr of attribution |
TotalServerConversions(integer) | Number of Conversions (event ID=3) |
Records(array) | All additional (non-total) details of the report. Description of Records is below. |
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.
Note
If the report you generated is too large, please try removing some dimensions, shortening the date range or reducing the date group granularity and generating the report again.
Caution
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
Information
Using any of the following ID "GroupBy" dimensions:
- "flightId", "advertiserId", "campaignId", "publisherAccountId", "creativeId", "adId", "channelId", "priorityId", "adTypeId", "siteId", "zoneId"
- "productSkuId", "productMainCategoryId", "productBranId", "productMerchantId",
will result in returning the corresponding name field e.g. "flightId"->"Flight" in Records[]->Details[]->Grouping, as in the example response.
Information
Some fields in the example response, such as the request reporting fields, are additional features. Contact your account manager for more information.