API Reference

Reach Estimate V2

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

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

Body Params
integer
required

ID of advertiser.

integer
required

ID the ad group.

integer
required

ID of the campaign.

date-time

Simulated start date for ad group scheduling.

date-time

Simulated end date for ad group scheduling.

targeting
object

Nested targeting object. An ad group may use only one of the following tactics, optionally combined with geo targeting using an AND relation.

metric
array of strings
required

The list of metrics you are requesting an estimate for.

metric*
Allowed:
timeframes
array of strings

Specifies the timeframes for which forecasts should be returned.
If not provided, forecasts for all available timeframes will be returned.

timeframes
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 26 days 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 26 days ago

Did this page help you?