Audience Size Estimate

post

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

This API provides audience size estimates for a given audience definition.
It supports both custom audience definitions and existing audiences identified by an audienceId. Audience size estimates are returned only for Rule-based and Advanced audiences.

Body Params

advertiserId

int64

required

ID of the advertiser.

audienceId

int64

ID of the audience.

audienceType

string

enum

Type of the audience.

Allowed:

attribute

string

enum

Type of custom audience.

Allowed:

date

Date to retrieve audience size estimates for.
By default, the current date (in ET) is used.
A custom date can only be specified when requesting a size estimate for a specific audienceId.

audienceDefinition

object

JSON object to define various criteria for the custom audience.
Must include this object when editing any nested objects.

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