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

Column	Description	Type
reportDate	Date on which the report was generated	date
campaignId	Campaign Id for which Target ROAS recommendation exists	Integer
recommendedTargetROAS	Recommended Target ROAS value	float
troasRecommendedDailyBudget	The recommended daily budget to set for the campaign to help maximize sales at the suggested ROAS target. This field will only be populated if available.	float
troasIncrementalSalesLower	The upper range of the potential incremental sales we predict your campaign can generate if you updated your campaigns with our recommendation following the learning phase	float
troasIncrementalSalesUpper	The upper range of incremental sales that you can obtain if you update your campaigns with our recommendations	float
troasRecommendationId	Recommendation ID for the target ROAS recommendation	string

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

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

Sample Response

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

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

reportDate	campaignId	recommendedTargetROAS
2024-06-12	600001	1.34
2024-06-12	600002	2.48
2024-06-12	600003	1.92

Sample Response 2

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

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

reportDate	campaignId	recommendedTargetROAS	troasRecommendedDailyBudget	troasRecommendationId	troasIncrementalSalesLower	troasIncrementalSalesUpper
2025-04-15	600007	5.0	600.0	11BF20FA-247D-46DA-A32A-51D082F3B334	1000.0	2000.0