Get Agency Account Campaigns

Retrieve a list of campaigns and their reports.

Query Parameters

next_page

string

Token for retrieving the next page.

limit

integer

default:100

Maximum number of campaigns to retrieve.

Required range: 1 <= x <= 1000

order_by

enum<string>

default:name

Dimension to order campaigns by.

Available options:

campaign_id,

name,

daily_budget,

impressions,

purchase_revenue,

roas,

cpc,

cpm,

ad_spend,

is_active,

ad_format,

start_date,

end_date,

created_at

direction

enum<string>

default:asc

Order direction for campaigns (ascending or descending).

Available options:

asc,

desc

start_date

string

Start date for calculating metrics.

end_date

string

End date for calculating metrics.

search

string

default:

Search string to filter campaigns by name.

is_running

boolean

Filter campaigns by their running status.

Response

200

application/json

Successful Response

campaigns

object[]

required

The vendor campaign with daily budget, roas and purchase_revenue

Show child attributes

campaigns.agencyCampaignId

string

required

The campaign name.

campaigns.campaignName

string

required

The campaign name.

campaigns.dailyBudget

integer

required

The daily budget set for this campaign. In minimum currency units.

Example:

1000

campaigns.endDate

string

required

The end date of the campaign.

campaigns.isActive

boolean

required

Whether this campaign is active.

campaigns.purchaseRevenue

integer

required

Revenue from promoted sales during the selected period in minor units of currency.

Required range: x >= 0

campaigns.roas

number

required

The return on ad spend during the selected period.

Required range: x >= 0

campaigns.startDate

string

required

The starting date of the campaign.

hasMore

boolean

required

Flag that indicates whether more results are available. true indicates there is a next page of results. false indicates this response contains the last page of results.

nextPage

string

Pagination cursor. Provide this value as a next_page query parameter in a new request to retrieve the next page of results.

Minimum length: 1

Example:

"SSBzb2xlbW5seSBzd2VhciB0aGF0IEkgYW0gdXAgdG8gbm8gZ29vZAo="