API Reference

Submit InsightType Snapshot Request

post
https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v1/snapshot/insight

You can create file-based snapshot containing attributes for all advertisers mapped to the API partner using this method.

Body Params

Details about the InsightType Report request by Advertisers

int32

The ID of the advertiser.

string
enum
required

The type of insight report requested.

Allowed:
string
enum
required

Format of the downloadable file.

Allowed:
reportMetrics
array of strings

Choose the metrics type for your snapshot.

Note: Please refer to Definition of Columns in the Advanced Insights Report for detailed information on report metrics.

reportMetrics
Headers
string
required

Auth signature as an API key.

string
required

We will provide you the consumer ID to access the API. It is same for all advertisers you access through the API.

integer
required

We will provide you with the KEY VERSION to access the API. It is same for all advertisers you access through the API.

integer
required

Timestamp for which the auth signature is generated. Use Unix epoch format.

string
required

The token will provide you the access to the API. It is same for all advertisers you access through the API.

Response

Updated 21 days ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
*/*

Updated 21 days ago