Create Report Snapshot
You can request a snapshot file for all performance reporting data available (until the date before current date) for a given advertiser using this method
Reporting data may be delayed by 24 to 48 hours from the time of the request.
Note: The POST functionality is similar for both Onsite and Offsite display
URL: POST/api/v1/snapshot/report
Definition of Retrievable Reports
The following table lists all supported reportType values and whether the report can be retrieved for Onsite Display and Offsite Display (TTD) campaigns.
| reportType | Report Name on UI | Onsite Display | Offsite Display |
|---|---|---|---|
| campaign | Provides overall performance metrics at the campaign level | ✅ Yes | ✅ Yes |
| lineItem | Provides ad group level performance metrics. | ✅ Yes | ✅ Yes |
| tactic | Provides tactic level performance metrics. | ✅ Yes | ✅ Yes |
| sku | Provides item level performance for items in the campaign's itemset | ✅ Yes | ✅ Yes |
| bid | The performance of bids for on-site display auction campaigns | ✅ Yes | ❌ No |
| newBuyer | Analyzes buying frequency of ad exposed shoppers | ✅ Yes | ✅ Yes |
| creative | Provides performance insights at the creative level | ✅ Yes | ❌ N |
Note:
SKU reports can produce very large files. We strongly recommend using a date range of 15 days or fewer (vs. the 60-day limit for other reports); if your ad campaign includes many items, reduce the date range even further to ensure the report completes reliably
Request Parameters
| Parameter | Description | Type | Required | Possible Values |
|---|---|---|---|---|
| advertiserId | The ID of the advertiser | integer | Y | Unique numeric identifier |
| startDate | The first day to be considered in the performance report snapshot. It cannot be the current date Note: The reports encompass data starting from midnight (00:00:00 hrs ET) on this particular date | date | Y | Date should be in format: yyyy-MM-dd |
| endDate | The last day to be considered in the performance report snapshot. It cannot be the current date. Note:
| date | Y | Date should be in format: yyyy-MM-dd |
| attributionWindow | Window for attribution Note: attributionWindow is applicable only when reportType = sku | string | Optional and applicable only for sku report | Allowed Values:
|
| salesChannel | Sales channel for the transaction Note: salesChannel is applicable only when reportType = sku | string | Optional and applicable only for sku report | If specified, the metrics applicable for the specified sales channel are returned. Allowed Values: stores, online, acc
|
| itemsetType | Type of item set Note: itemsetType is applicable only when reportType = sku | string | Optional and applicable only for sku report | If specified, the metrics applicable for the specified itemsetType are returned. Allowed Values: halo, featured, total
|
| reportType | Type of report to be retrieved | string | Y | Types of Report: campaign, lineItem, tactic, sku, bid, newBuyer, creative |
| reportMetrics | Choose the metrics type for your snapshot Note: If you omit this parameter in your request, you will receive all the metrics that are relevant to the selected report type | string | N | Please refer to the table “Definition of Various Parameters Generated Across the Snapshot Reports” for detailed information on report metrics |
| scope | Scope of campaign | string | Optional and applicable only for campaign/lineItem/sku/newBuyer |
|
Response
| Element | Description | Type |
|---|---|---|
| code | The response code can have following values:
| string |
| details | Details of the error if value of response code is failure | string |
| snapshotId | ID of the snapshot | string |
| jobStatus | It is an indicator to confirm status of snapshot generation.The possible values of jobStatus are: pending, processing, done, failed, expired | string |
Troubleshooting Tip:
Slow Report Generation: If your report is taking a long time to generate or if the API response times out, try reducing the date range
Updated 1 day ago