API Reference

List Audiences

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

You can retrieve the list of custom audiences and their associated metadata with this method.

Body Params
int64
required

ID of the advertiser.

int32

Defines at which point in the list to return audiences.
Use startIndex and count to return various selections of the list.

int32

Number of records to be returned in the response.

Filter[audienceId]
array of int64s

IDs of custom audiences whose metadata are to be returned.

Filter[audienceId]
Filter[name]
array of strings

Filter based on the list of specified audience names.

If no audience names are specified, all audiences in the advertiser account will be returned.

Filter[name]
Filter[status]
array of strings

Filter based on the audience status.

Filter[status]
Allowed:
string
enum

Specifies whether to return audiences that are either owned by the advertiser or shared with them.

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

Did this page help you?