Retrieve Advanced Insights Report
Description
You can download Advanced Insights report by providing snapshot id
URL: GET/api/v1/snapshot
Query Parameters
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 |
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
Element | Description | Type |
---|---|---|
code | The response code can have following values: success , failure | string |
details | Details of the error if value of response code is failure | string |
snapshotId | ID of the snapshot generated through POST endpoint response | string |
jobStatus | It 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”:
reportDate | catalogItemId | price | buyboxWinnerPrice | publishedStatus | inventoryCount |
---|---|---|---|---|---|
1/31/2024 | 11112222 | 35.50 | 35.50 | 1 | 175 |
1/31/2024 | 22223333 | 32.50 | 32.50 | 1 | 70 |
1/31/2024 | 33334444 | 15.99 | 14.95 | 1 | 28 |
Updated about 2 months ago