API Reference

List Campaigns

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

You can download the list of all campaigns along with their associated attributes in the advertiser accounts using this POST operation.

Body Params
int64
required

ID of advertiser.

int32

Defines at which point in the list to return campaigns. Use startIndex and count to return various selections of the list.
The default value is 0.

int32

Defines the total number of campaigns to be returned. Use startIndex and count to return various selections of the list.
The default value is 100. The minimum value is 1. The maximum value is 100.

Filter[campaignId]
array of int64s

ID of the campaigns you wish to list details for.

Filter[campaignId]
string
enum

Filter based on the campaign status.

Allowed:
Filter[name]
array of strings

Filter based on the list of specified campaign names.

Filter[name]
date-time

Filter list of campaigns created or modified on or after this date.

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

Did this page help you?