GET
/
public
/
v1
/
toppie
/
reporting
/
campaigns
curl --request GET \
  --url https://api.topsort.com/public/v1/toppie/reporting/campaigns
{
  "campaigns": [
    {
      "agencyCampaignId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "campaignName": "<string>",
      "dailyBudget": 1000,
      "endDate": "2023-11-07T05:31:56Z",
      "isActive": true,
      "purchaseRevenue": 1,
      "roas": 1,
      "startDate": "2023-11-07T05:31:56Z"
    }
  ],
  "hasMore": true,
  "nextPage": "SSBzb2xlbW5seSBzd2VhciB0aGF0IEkgYW0gdXAgdG8gbm8gZ29vZAo="
}

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>

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>

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

​
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="