Real Time Reporting API
Notion
Real Time Reporting API data is a cumulative count of all the impressions, clicks, etc. since either:
- The creation of your advertiser/campaign/etc.
- June 1, 2016
To get data for a custom time period, use the parameters described in the endpoints. Data for a custom period is provided only for the past 90 days.
Caution
Real time data is updated approximately every five minutes.
Parameters
| Parameter | Description |
|---|---|
| impressions | A count of impressions for the time period — the number of times an impressionUrl was fired |
| clicks | A count of clicks for the time period — the number of times a clickUrl was fired |
| conversions | A count of conversions for the time period — the sum of Event IDs 1, 2, and 3 fired (see Event ID definitions) |
| revenue | A count of revenue for the time period |
| gmv | A count of gross merchandise value for the time period if GMV is passed on events |
Click Bucketing Parameters
These counts originate from the click bucketing feature. Refer to that page for full definitions. Click bucketing data in the Real Time Reporting API is not available prior to June 1, 2021.
| Parameter | Description |
|---|---|
| uniqueclicks | A count of Unique Clicks |
| fraudclicks | TBA |
| rawclicks | A count of Raw Clicks |
| invaliduaclicks | A count of Invalid User Agent Clicks |
| duplicateimpressionclicks | A count of Duplicate Impression Clicks |
| testclicks | TBA |
| suspiciousclicks | A count of Suspicious Clicks |
Error Handling
| 400 Error Message | Likely Cause |
|---|---|
Does not exist |
Requesting an id that doesn't exist using a GET endpoint |
Cannot request data more than 90 days old |
Requesting a custom time period outside of past 90 day range |
Start date must be before end date |
Requesting a start date that's later than the end date |
No data for id returned |
Requesting an id that doesn't exist using a POST endpoint |