Note: The format of the report is CSV, and it will be enclosed in “gzip” file format by default.
| Column | Description | Type |
|---|
| reportDate | Date on which the report was generated | date |
| campaignId | Campaign Id for desired recommendations report | Integer |
| budgetType | The budget type of the campaign for which the report was requested | string |
| missedClicksLower | This field provides cumulative lower range of missed clicks over last 7 days for a campaign which went out of budget (OOB) for T-1 time | integer |
| missedClicksUpper | This field provides cumulative upper range of missed clicks over last 7 days for a campaign which went out of budget (OOB) for T-1 time | integer |
| missedImpressionsLower | This field will provide cumulative lower range of missed impressions over last 7 days for a campaign which went out of budget (OOB) for T-1 time | integer |
| missedImpressionUpper | This field will provide cumulative upper range of missed impressions over last 7 days for a campaign which went out of budget (OOB) for T-1 time | integer |
| suggestedLatestDailyBudget | This field provides the suggested latest daily budget recommendation to be applied to a campaign so that the campaign does not go out of budget. | double |
| suggestedLatestTotalBudget | This field provides the suggested latest total budget recommendation to be applied to a campaign so that the campaign does not go out of budget. | double |
| avgCapOutTime | The average cap out time is the average time for which the campaign went out of budget in the last 7 days. This value is represented in military time e.g. 1000 refers to 10 AM. | integer |
| Header Name | Description | Required | Values |
|---|
| Authorization | The token will provide you the access to the API. It is same for all advertisers you access through the API. | Y | Please utilize the generated auth_token shared with you at the time of partner onboarding from the Getting Started Guide |
| WM_CONSUMER.ID | We will provide you the consumer ID to access the API. It is same for all advertisers you access through the API. | Y | Please use the generated ConsumerId shared with you at the time of partner onboarding. Refer to the Getting Started Guide for more information |
| WM_SEC.AUTH_SIGNATURE | Auth signature as an API key. | Y | Use the signature generator code from Getting Started Guide to generate this value |
| WM_SEC.KEY_VERSION | We will provide you with the KEY VERSION to access the API. It is same for all advertisers you access through the API. | Y | 1 |
| WM_CONSUMER.intimestamp | Timestamp for which the auth signature is generated. Use Unix epoch format for the timestamp. | Y | Use the signature generator code from Getting Started Guide to generate this value |
| Content-Type | Format of the message body | Y | application/json |
| Parameter | Description | Type | Required | Possible Values |
|---|
| advertiserId | The ID of the advertiser | integer | Y | Unique numeric identifier |
| snapshotId | The ID of the snapshot | string | Y | Unique alpha numeric identifier |
curl -X GET\ 'https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v2/snapshot?advertiserId=600001&snapshotId=10' \ --header 'Authorization: Bearer <auth_token>' \ --header 'accept: application/json' \ --header 'WM_SEC.AUTH_SIGNATURE: ***********' \ --header 'WM_SEC.KEY_VERSION: 1' \ --header 'WM_CONSUMER.ID: adfwe-v23-faasd2r-afs-asdfqeff' \ --header 'WM_CONSUMER.intimestamp: 1565309779' \
| Element | Description | Type |
|---|
| snapshotId | Id of the snapshot to be retrieved | string |
| jobStatus | It is an indicator to confirm status of snapshot generation. The possible values of jobStatus are: pending, processing, done, failed, expired | string |
| details | Provides download URL when jobStatus reaches done state | string |
| code | The response code can have following values: success, failure | string |
{ "code": "success", "snapshotId": "12", "details": "", "jobStatus": "pending" }
| startDate | endDate | campaignId | budgetType | missedClicksLower | missedClicksUpper | missedImpressionsLower | missedImpressionsUpper | suggestedLatestDailyBudget | suggestedLatestTotalBudget | avgCapOutTime |
|---|
| 2025-09-12 | 2025-09-19 | 600000 | daily | 50 | 200 | 100 | 500 | 624.94 | 65789.01 | 1000 |
