Auction examples
- Running auctions
- Sponsored listings
- Sponsored banners
- Sponsored brands
Asset examples
Webhook examples
Assets API
Billing API
Campaign API
- GETGet Campaigns
- POSTCreate Campaign
- GETGet Campaign By Id
- DELDelete Campaign By Id
- PATCHUpdate Campaign By Id
- GETGet Campaign Bids
- POSTCreate Campaign Bids
- DELDelete Campaign Bid By Id
- PATCHUpdate Campaign Bid By Id
- POST[BETA] Get estimated clicks of a future campaign for a given vendor
- GETGet Products In Campaign
- GETGet Sponsored Products
Catalog API
Invitation API
Modal API
Reporting API
Toppie API
- GET[BETA] Get Toppie Campaigns
- POST[BETA] Create Toppie Campaign
- GET[BETA] Get Toppie Campaign Details
- GET[BETA] Get Toppie Campaign Bids
- GETGet Agency Account Report
- GETGet Agency Account Activity
- GETGet Agency Account Campaigns
- GETGet Account Campaigns By Ids
- GETGet Agency Campaign Report
- GETGet Campaign Report Per Product
Get Agency Campaign Report
Retrieve a detailed report for a specific campaign.
curl --request GET \
--url https://api.topsort.com/public/v1/toppie/reporting/campaigns/{campaign-id}{
"reports": [
{
"adSpend": 1,
"chargedClicks": 1,
"chargedImpressions": 1,
"clicks": 1,
"conversionRate": 123,
"cpc": 123,
"ctr": 123,
"impressions": 1,
"purchaseCount": 1,
"purchaseRevenue": 1,
"roas": 123,
"timegroup": "2023-12-25"
}
]
}Path Parameters
The ID of the campaign.
Query Parameters
The start date for which reports will be generated.
The end date for which reports will be generated.
Response
Response for analytics kpis.
Amount spent on ads during the selected period in minor units of currency.
x > 0Amount of charged clicks during the selected period.
x > 0Amount of charged impressions during the selected period.
x > 0Number of clicks during the selected period.
x > 0The conversion rate during the selected period.
Average cost per click during the selected period.
The click through rate during the selected period.
Number of impressions during the selected period.
x > 0Number of purchases during the selected period.
x > 0Revenue from promoted sales during the selected period in minor units of currency.
x > 0The return on ad spend during the selected period.
Timegroup for the Kpis.
curl --request GET \
--url https://api.topsort.com/public/v1/toppie/reporting/campaigns/{campaign-id}{
"reports": [
{
"adSpend": 1,
"chargedClicks": 1,
"chargedImpressions": 1,
"clicks": 1,
"conversionRate": 123,
"cpc": 123,
"ctr": 123,
"impressions": 1,
"purchaseCount": 1,
"purchaseRevenue": 1,
"roas": 123,
"timegroup": "2023-12-25"
}
]
}