Auction examples
Webhook examples
Toppie API
- GET[BETA] Get Toppie Campaigns
- POST[BETA] Create Toppie Campaign
- GET[BETA] Get Agency Account Report.
- GET[BETA] Get Campaigns Reporting.
- GET[BETA] Account Activity Reports.
- GETGet Agency Daily Kpis By Product Dump Urls
- GET[BETA] List Account Products
- GET[BETA] Get Toppie Campaign Details
- DEL[BETA] Delete Toppie Campaign
- PATCH[BETA] Update Toppie Campaign
- GET[BETA] Get Toppie Campaign Bids
- GET[BETA] Get Campaign Report.
- GET[BETA] Get Campaign Products Report.
Campaign API
- GETGet Restriction Types
- GETGet Json Templates
- POSTCreate Json Template
- GETGet Campaigns
- POSTCreate Campaign
- POST[BETA] Get estimated clicks of a future campaign for a given vendordeprecated
- GETGet Sponsored Productsdeprecated
- GETGet Products In Campaign
- POST[BETA] Create exclusive listing campaign.
- POST[BETA] Create exclusive banner campaign.
- GETGet Campaign Restriction
- POSTCreate Campaign Restriction
- PATCHUpdate Campaign Restriction
- GETGet Restriction Type
- GETGet Json Template
- PATCHUpdate Json Template
- GETGet Campaign By Id
- DELDelete Campaign By Id
- PATCHUpdate Campaign By Id
- GETGet Campaign Bids
- POSTCreate Campaign Bids
- DELDelete All Bids From A Campaign
- DELDelete Campaign Bid By Id
- PATCHUpdate Campaign Bid By Id
- GETGet Campaign Products
- PUTUpsert Campaign Products
- GET[BETA] Get exclusive listing campaign by ID.
- PATCH[BETA] Update exclusive listing campaign by ID.
- GET[BETA] Get exclusive banner campaign by ID.
- PATCH[BETA] Update exclusive banner campaign by ID.
Catalog API
Billing API
- GETGet Marketplace Credit Limitdeprecated
- POSTSet Marketplace Credit Limitdeprecated
- GETGet Vendor Chargesdeprecated
- GETGet Billing Contacts
- PUTUpsert Vendor Billing Contact
- GETGet Campaign Billing Contact
- PUTUpsert Campaign Billing Contact
- GETGet Vendor Wallets
- POSTCreate Wallet
- GETGet Vendor Credit Limitdeprecated
- POSTSet Vendor Credit Limitdeprecated
- GETGet Vendor Credit Historydeprecated
- GETGet Vendor Account Activitydeprecated
- GETGet Vendor Balance
- POSTAdd Vendor Balance
- POSTBurn Vendor Balance
- POSTAdjust Wallet Balance
- GETGet Billing Contact
- PUTUpsert Billing Contact
- DELDelete Vendor Billing Contact
Reporting API
- GETGet Marketplace Report
- GETGet Marketplace Daily Report
- GETGet Marketplace Vendors Kpis
- GETGet Marketplace Campaigns Kpis
- GETGet Marketplace Interactions Report
- GETGet Scored Attribution Dump Urls
- GETGet Interactions Dump Urls
- GETGet Vendor Report
- GETGet Vendor Daily Report
- GETGet Campaign Report
- GETGet Campaign Daily Report
- GETGet Product Daily Report
- GETGet Campaign Report By Product
- GETGet Product Report
Invitation API
Assets API
Segments Service
Offsite Ads API
- POSTCreate a new advertiser
- GETGet vendor offsite campaigns
- POSTCreate Campaign
- GETList Audiences
- POST[BETA] Create offsite user list audience job.
- PUTUpsert Advertiser Domain
- GETGet Job Status
- GETGet advertiser onboarding state for a specific DSP
- GETGet campaign information
- PATCHUpdate Campaign
- GETGet Campaign Products Report
- GETGet Campaign Aggregated Report
- GETGet Campaign Daily Report
Forecasting Service
API Reference
curl --request GET \
--url https://api.topsort.com/public/v1/reporting-service/vendors/{vendor-id} \
--header 'Authorization: Bearer <token>'{
"impressions": {
"total": 123,
"charged": 123,
"adSpent": 123,
"adSpentDecimal": "<string>"
},
"clicks": {
"total": 123,
"charged": 123,
"adSpent": 123,
"adSpentDecimal": "<string>"
},
"purchases": {
"amount": 123,
"count": 123,
"quantity": 123,
"countByProduct": {}
},
"auctions": {
"percentageWon": 123,
"won": 123,
"lost": 123
}
}Get Vendor Report
Endpoint to get a vendor’s total behavioral summary report between given dates.
curl --request GET \
--url https://api.topsort.com/public/v1/reporting-service/vendors/{vendor-id} \
--header 'Authorization: Bearer <token>'{
"impressions": {
"total": 123,
"charged": 123,
"adSpent": 123,
"adSpentDecimal": "<string>"
},
"clicks": {
"total": 123,
"charged": 123,
"adSpent": 123,
"adSpentDecimal": "<string>"
},
"purchases": {
"amount": 123,
"count": 123,
"quantity": 123,
"countByProduct": {}
},
"auctions": {
"percentageWon": 123,
"won": 123,
"lost": 123
}
}Authorizations
A valid API key generated in Topsort's UI.
Path Parameters
The ID of the vendor.
1Query Parameters
The start date for which reports will be generated.
The end date for which reports will be generated.
Response
Successful Response
Auctions information attributed to this report item in addition to normal report data.
How many impressions are attributed to this report item.
Show child attributes
Show child attributes
Total number of events.
Number of charged events.
Ad spent over a period of time, in minor units of currency according to ISO 4217.
Ad spent over a period of time.
How many clicks are attributed to this report item.
Show child attributes
Show child attributes
Total number of events.
Number of charged events.
Ad spent over a period of time, in minor units of currency according to ISO 4217.
Ad spent over a period of time.
How many purchases are attributed to this report item.
Show child attributes
Show child attributes
Amount of money made by purchases over a period of time, in minor units of currency according to ISO 4217.
Amount of purchase events.
Amount of items purchased.
How many auctions are attributed to this report item.
Show child attributes
Show child attributes
Was this page helpful?