Retrieve Advanced Insights Report

Description

You can download Advanced Insights report by providing snapshot id

URL: ​GET/api/v1/snapshot

Query Parameters

ParameterDescriptionTypeRequiredPossible Values
advertiserIdThe ID of the advertiserintegerYUnique numeric identifier
snapshotIdThe ID of the snapshotstringYUnique alpha numeric identifier

Sample Request

curl -X GET \
'https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v1/snapshot?snapshotId=10&advertiserId=600001' \
--header 'Authorization: Bearer <auth_token>' \
--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' \
--header 'accept: application/json' \

Response

ElementDescriptionType
codeThe response code can have following values:   success, failurestring
detailsDetails of the error if value of response code is failurestring
snapshotIdID of the snapshot generated through POST endpoint responsestring
jobStatusIt is an indicator to confirm status of snapshot generation
The possible values of jobStatus are: pending, processing, done, failed, expired
string

Sample Response

[ { "jobStatus": "done", "code": "success", "snapshotId": "10", "details": "https://advertising.walmart.com/qa/file/10" }
]

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

reportDatecatalogItemIdpricebuyboxWinnerPricepublishedStatusinventoryCount
1/31/20241111222235.5035.501175
1/31/20242222333332.5032.50170
1/31/20243333444415.9914.95128