📘
URL: POST/api/v1/snapshot/insight

Request Parameters

Parameter	Description	Type	Required	Possible Values
insightType	The type of insight report requested	string	Y	advertiserAttributes, advertiserAttributesV2
format	Format of the downloadable file	string	Y	`zip`, `gzip`

Headers

Header Name	Description	Required	Values
Authorization	The token will provide you the access to the API. It is same for all advertisers you access through the API.	Y	Please utilize the generated `auth_token` shared with you at the time of partner onboarding from the Getting Started Guide
WM_CONSUMER.ID	We will provide you the consumer ID to access the API. It is same for all advertisers you access through the API.	Y	Please use the generated `ConsumerId` shared with you at the time of partner onboarding. Refer to the Getting Started Guide for more information
WM_SEC.AUTH_SIGNATURE	Auth signature as an API key.	Y	Use the signature generator code from Getting Started Guide to generate this value
WM_SEC.KEY_VERSION	We will provide you with the KEY VERSION to access the API. It is same for all advertisers you access through the API.	Y	1
WM_CONSUMER.intimestamp	Timestamp for which the auth signature is generated. Use Unix epoch format for the timestamp.	Y	Use the signature generator code from Getting Started Guide to generate this value
Content-Type	Format of the message body	Y	application/json

Sample Request 1

curl -X POST \ 'https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v1/snapshot/insight' \
--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' \
--data '{ "insightType": "advertiserAttributes", "format": "zip" }'

Sample Request 2

curl -X POST \ 'https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v1/snapshot/insight' \
--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' \
--data '{ "insightType": "advertiserAttributesV2", "format": "zip" }'

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	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 1

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

Sample Response 2

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