Poll for Queued Report Result

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

Message
(string)

If Status is Error, this will contain the error message, null otherwise

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

Title
(string)

Deprecated

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.

ReportId
(string)

Deprecated

RecordTitle
(string)

Deprecated

StartDate
(string)

In the format of YYYY-MM-DDTHH:MM:SS. Deprecated in favor of StartDateISO

StartDateISO
(string)

In the format of YYYY-MM-DDTHH:MM:SS.0000000

EndDate
(string)

In the format of YYYY-MM-DDTHH:MM:SS. Deprecated in favor 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)

TotalUniqueCTR
(float)

Total clickthrough rate (derived from TotalUniqueBucketClicks)

TotalRevenue
(float)

Total revenue. Deprecated in favor of TotalTrueRevenue

TotalTrueRevenue
(float)

Total revenue

TotalGMV
(float)

Total Gross Merchandise Value

TotalROAS
(float)

Total Return On Ad Spend (derived from TotalGMV)

TotalECPM
(float)

Total eCPM

TotalImpressions
(integer)

Total impressions

TotalRequests
(integer)

(BETA) Total requests for the placements. (Does not include Passback and RTB Requests)

TotalRtbMatchedRequests
(integer)

(BETA) Number of times RTB partner(s) received a request AND a user was matched, regardless of whether they bid

TotalRtbRequests
(integer)

(BETA) Number of times RTB partner(s) received a request, regardless of whether they bid

TotalRtbBidRequests
(integer)

(BETA) Number of times Kevel received a bid from a RTB provider

TotalPassbackRequests
(integer)

(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

TotalFillRate
(float)

(BETA) TotalImpressions divided by TotalRequests as a percentage

OptionRecords
(array)

Deprecated

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.

🚧

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.

Language
Authentication
Header