API Reference

Submit Report Snapshot Request

post
https://developer.api.us.stg.walmart.com/api-proxy/service/display/api/v1/api/v1/snapshot/report

You can request a snapshot file for all performance reporting data available (until the date before current date) for a given advertiser using this method.
Reporting data may be delayed by 24 to 48 hours from the time of the request.

Body Params
integer
required

Id of advertiser.

date
required

The day to be considered in the performance report snapshot. It cannot be the current date.

date
required

The last day to be considered in the performance report snapshot. It cannot be the current date.

string
enum
required

Type of report to be retrieved.
Note: basketAnalysis, ivtViewability reports are available only for Onsite display.

reportMetrics
array of strings

Choose the metrics type for your snapshot.

Note: If you omit this parameter in your request, you will receive all the metrics that are relevant to the selected report type.

reportMetrics
string
enum

Window for attribution. attributionWindow is applicable only when reportType is set to sku.

Allowed:
string
enum

Type of item set. itemsetType is applicable only when reportType is set to sku.

Allowed:
string
enum

Sales channel for the transaction. salesChannel is applicable only when reportType is set to sku.

Allowed:
string
enum

Controls the aggregation level at which report metrics are returned.

Allowed:
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. The allowed value is 1.

integer
required

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

string
required

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

Responses

Updated about 14 hours ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 14 hours ago

Did this page help you?