Audience Intelligence

post

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

Returns audience insights across demographic and geographic dimensions for previously built audiences.

Body Params

advertiserId

int64

required

ID of the advertiser.

audienceId

int64

required

ID of the audience to request insights.

startDate

date

required

Start date for the insights requested.

endDate

date

required

End date for the insights requested.

dimension

string

enum

Dimension to filter insights.

Note:
- Only one dimension is allowed per request.
- If a dimension is not specified, the request returns insights for all dimensions.

Allowed:

dmaLimit

int32

Number of top DMAs to return. Only applicable when dimension is set to DMA.

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