Guides

Create Report Snapshot

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.

reportTypeReport Name on UIOnsite DisplayOffsite Display
campaignProvides overall performance metrics at the campaign level✅ Yes✅ Yes
lineItemProvides ad group level performance metrics.✅ Yes✅ Yes
tacticProvides tactic level performance metrics.✅ Yes✅ Yes
skuProvides item level performance for items in the campaign's itemset✅ Yes✅ Yes
bidThe performance of bids for on-site display auction campaigns✅ Yes❌ No
newBuyerAnalyzes buying frequency of ad exposed shoppers✅ Yes✅ Yes
creativeProvides performance insights at the creative level✅ Yes❌ No
📌

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:***
  • The reports encompass data until the end of the day (23:59:59 hrs ET) for this particular date 
  • If report data is not available for the requested end date, the request will fail, and the response will contain endDate until which the performance report is available
 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:
  • days14: Report will include 14-day attribution columns If a user selects this value
  • days30: Report will include 30-day attribution columns if a user selects this value
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`
  • stores: If specified, only metrics prefixed with storeAttributed are returned
  • online: If specified, only metrics prefixed with pickupAttributed, deliveryAttributed are returned
  • acc: If specified, only metrics prefixed with accAttributed are returned
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`
  • halo: if specified, only metrics are returned that have “Halo“ in it
  • featured: if specified, only metrics are returned that have “Featured“ in it
  • total: if specified, only metrics are returned that have “Halo“ or “Featured“ in it
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**](https://developer.walmart.com/advertising-partners/docs/definition-of-various-parameters-generated-across-the-snapshot-reports)**”** for detailed information on report metrics
scope Controls the aggregation level at which report metrics are returned. string N Possible values: `CAMPAIGN`, `CAMPAIGN_GROUP`
  • When `reportType` is set to `campaign`, `lineItem`, `sku`, or `newBuyer`, the default value of `scope` = `CAMPAIGN`
  • When `reportType` is set to `creative`, `tactic`, or `bid`: `scope` = `CAMPAIGN_GROUP` is not supported and will return an error.
  • When `scope` = `CAMPAIGN_GROUP`, the `campaign`, `lineItem`, `sku`, `newBuyer` reports will have 2 additional fields: `campaignGroupId` and `campaignGroupName`
  • If `scope` isn't defined in the request, it will be set to `CAMPAIGN` by default.

Notes on scope parameter

  • When scope = campaign_group, the API returns rows only for campaigns that belong to a campaign group. Standalone campaigns, that are not part of any groups, are excluded.
  • Campaign groups can span multiple advertisers. You can retrieve a group report only if you have view access to all campaigns in that group.
  • New buyer Report: For campaigns that are in a group, when scope = campaign_group metrics are returned at the campaign_group level and are identical across all campaigns in that group.
    To download newBuyer reports for campaigns that are not in any campaign group, use scope = campaign

Response

ElementDescriptionType
code

The response code can have following values:

  • success
  • failure

string
detailsDetails of the error if value of response code is failurestring
snapshotIdID of the snapshotstring
jobStatusIt is an indicator to confirm status of snapshot generation.The possible values of jobStatus are: pending, processing, done, failed, expiredstring

🔧

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