Retrieve Campaign Recommendations Snapshot

Note: The format of the report is CSV, and it will be enclosed in “gzip” file format by default.

Definition of Columns in the Campaign Recommendations Report

ColumnDescriptionType
reportDateDate on which the report was generateddate
campaignIdCampaign Id for desired recommendations reportInteger
budgetTypeThe budget type of the campaign for which the report was requestedstring
missedClicksLowerThis field provides cumulative lower range of missed clicks over last 7 days for a campaign which went out of budget (OOB) for T-1 timeinteger
missedClicksUpperThis field provides cumulative upper range of missed clicks over last 7 days for a campaign which went out of budget (OOB) for T-1 timeinteger
missedImpressionsLowerThis 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 timeinteger
missedImpressionUpperThis 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 timeinteger
avgCapOutTimeThe 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

Sample Request

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' \ 

Response

ElementDescriptionType
snapshotIdId of the snapshot to be retrieved  string
jobStatusIt is an indicator to confirm status of snapshot generation. The possible values of jobStatus are: pending, processing, done, failed, expiredstring
detailsProvides download URL when jobStatus reaches done statestring
codeThe response code can have following values: success, failurestring

Sample Response

 { "code": "success", "snapshotId": "12", "details": "", "jobStatus": "pending" }

Example of the content of snapshot with id “10”. The file format is “CSV”:

startDateendDatecampaignIdbudgetTypemissedClicksLowermissedClicksUppermissedImpressionsLowermissedImpressionsUpperavgCapOutTime
2025-09-122025-09-19600000daily502001005001000