Create Report Snapshot

post

https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v2/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.

Body Params

advertiserId

int32

required

The ID of the advertiser.

Note: This parameter can take only one advertiser ID for each snapshot report request.

reportDate

string

required

The snapshot date for the report. This parameter can take only one report date for the last 90 days for each snapshot report request.

Note:
- To fetch reports , please use either reportDate, or combination of startDate and endDate.
Using both together will result in an error. However, at least one of these must be defined.
- reportDate must not be defined for the following report types or the request will cause an error.
- searchImpression
- itemHealth

startDate

string

required

The first day to be considered in the performance report snapshot.

Note:
- To fetch reports , please use either reportDate, or combination of startDate and endDate. Using both together will result in an error.
- startDate must not be defined for the following report types or the request will cause an error.
- itemHealth
- It cannot be the current date.

endDate

string

required

The last day to be considered in the performance report snapshot.

reportType

string

enum

required

The type of the performance report for which the snapshot should be generated.
This parameter can take one report type among the possible report types in each snapshot report request.

reportMetrics

array of strings

required

Choose the metrics type for your snapshot. Not all metrics are applicable to all report types.
Each report requires at least one dimension to be included in the reportMetrics parameter or else the report request will fail.
This parameter can take one or more than one report metric among the possible report metrics in each snapshot report request.

NOTE: Possible reportMetrics values for Dimensions and Metrics that are accepted for reportMetrics,
Please refer to the table Definition of Various Parameters Generated Across the Snapshot Reports.

reportMetrics*

Headers

WM_SEC.AUTH_SIGNATURE

string

required

Auth signature as an API key.

WM_CONSUMER.ID

string

required

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

WM_SEC.KEY_VERSION

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.

WM_CONSUMER.intimestamp

integer

required

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

Response

200successful operation