Reach Estimate

post

https://developer.api.us.stg.walmart.com/api-proxy/service/display/api/v1/api/v1/reachEstimate

Use this API to request a reach estimate or impressions opportunity forecast for a given ad group.

Body Params

advertiserId

integer

required

ID of advertiser.

adGroupId

integer

required

ID the ad group.

campaignId

integer

required

ID of the campaign.

startDate

date-time

Date when the ad group is set to go live.

endDate

date-time

The date when ad group ends.

targeting

object

The targeting criteria for the ad group.

metric

array of strings

required

The specified metric you are requesting an estimate for.

Note: impressions is currently the only supported metric.

metric*

Allowed:

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

WM_CONSUMER.intimestamp

integer

required

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

Authorization

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

200successful operation

400Invalid request parameters supplied

401Unauthorized

403Forbidden

500Internal Server Error