Auction examples
- Running auctions
- Sponsored listings
- Sponsored banners
- Sponsored brands
Asset examples
Webhook examples
Toptimize
Assets API
Billing API
- GETGet Billing Contacts
- GETGet Billing Contact
- PUTUpsert Billing Contact
- GETGet Campaign Billing Contact
- PUTUpsert Campaign Billing Contact
- GETGet Marketplace Credit Limit
- POSTSet Marketplace Credit Limit
- PUTUpsert Vendor Billing Contact
- GETGet Vendor Charges
- GETGet Vendor Account Activity
- GETGet Vendor Balance
- POSTAdd Vendor Balance
- POSTBurn Vendor Balance
- GETGet Vendor Credit History
- GETGet Vendor Credit Limit
- POSTSet Vendor Credit Limit
- DELDelete Vendor Billing Contact
- GETGet Vendor Wallets
- POSTCreate Wallet
- POSTAdjust Wallet Balance
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
- GETGet Campaign Report
- GETGet Campaign Daily Report
- GETGet Campaign Report By Product
- GETGet Product Report
- GETGet Product Daily Report
- GETGet Marketplace Interactions Report
- GETGet Marketplace Report
- GETGet Marketplace Campaigns Kpis
- GETGet Marketplace Daily Report
- GETGet Marketplace Vendors Kpis
- GETGet Vendor Report
- GETGet Vendor Daily Report
Segments Service
Toppie API
- GET[BETA] Get Agency Account Balance
- GET[BETA] Get Agency Account Top-ups
- GET[BETA] Get Toppie Campaigns
- POST[BETA] Create Toppie Campaign
- GET[BETA] Get Toppie Campaign Details
- PATCH[BETA] Update Toppie Campaign
- GET[BETA] Get Toppie Campaign Bids
- GETList Account Products
- 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 Account Report
Retrieve a general report for an account.
curl --request GET \
--url https://api.topsort.com/public/v1/toppie/reporting{
"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"
}
]
}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{
"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"
}
]
}