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.
URL: POST/api/v1/snapshot/report
Query 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 | date | Y | Date should be in format: yyyy-MM-dd Note: This parameter is not applicable for Item Health report and the value will be ignored, however it is still required in the request |
| endDate | The last day to be considered in the performance report snapshot. It cannot be the current date. Note: 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 Note: This parameter is not applicable for Item Health report and the value will be ignored, however it is still required in the request. |
| attributionWindow | Window for click attribution. Note: Window for view attribution is 1 day by default. | string | Y | Allowed Values: 1) days3: Report will include 3-day attribution columns If a user selects this value. 2) days30: Report will include 30-day attribution columns if a user selects this value. 3) days14: Report will include 14-day attribution columns if a user selects this value. 4) allWith14: Report will include 3, 14, and 30-day attribution columns if a user selects this value 5) all: Report will include 3 and 30-day attribution columns If a user selects this value. Report will NOT include 14-day attribution columns if a user selects this value Note: 14-day attribution data will only be available for period beyond 11/25/2019. Prior to this date, the value returned will be ‘0’. This parameter is not applicable for Item Health report and the value will be ignored. However, it is still required in the request |
| reportType | Type of report to be retrieved | string | Y | Types of Report: keyword, adItem, platform, pageType, adGroup, brand, category, itemKeyword, itemHealth, itemHealthV2, placement |
| extraFields | extraFields holds following parameters: date, splitAttribution | string | N | Get report snapshot aggregated at day level if you need a report by day Note: Report by day can only be pulled for a maximum period of two months or 61 days. An error message will be returned if report is requested for more than the length of this time period. This parameter is not applicable for Item Health report and the value will be ignored; however, it is still required in the requests splitAttribution: Use this parameter to get revenue break up by a) P&D (Pickup and Delivery) or b) Walmart.com along with other metrics Note: With splitAttribution, you receive report snapshot aggregated by day, by default. So, use of date is not required |
| format | Choose the format type for your snapshot | string | N | Types of Format: gzip, zip Note: gzip allows decompression while file is being transferred over the network, hence it is a faster and simpler way to download the reports. You will receive snapshot in zip format if no specific format is specified |
Note:
- Response will be by default aggregated by the entire period requested. So, to get the report by day, please include the
extraFieldsparameter with the value “date” in the request for all the report types exceptitemHealthanditemHealthV2reports. - Request by “date”(extra field), start/end dates, and attributionWindow parameters are not applicable for Item Health report. The values provided will be ignored when requesting
itemHealthanditemHealthV2snapshot reports. However, these parameters are still required for all snapshot report generation. - To get report by campaigns, request report for adgroups and use the campaign ids returned in the report to aggregate the report.
Updated about 1 month ago