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

ColumnDescriptionTypePossible Values
reportDateDate on which the report was generateddate
campaignIdCampaign Id for which Target ROAS recommendation existsInteger
recommendedTargetROASRecommended value of Target ROASfloat

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": "10", "details": "", "jobStatus": "pending" }

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

reportDatecampaignIdrecommendedTargetROAS
2024-06-126000011.34
2024-06-126000022.48
2024-06-126000031.92