Reporting API
Get Vendor Report
Auction examples
- Running auctions
- Sponsored listings
- Sponsored banners
- Sponsored brands
Asset examples
Webhook examples
Events
Audience 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
Assets API
Audience 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
Reporting API
Get Vendor Report
Endpoint to get a vendor’s total behavioral summary report between given dates.
GET
/
public
/
v1
/
reporting-service
/
vendors
/
{vendor-id}
curl --request GET \
--url https://api.topsort.com/public/v1/reporting-service/vendors/{vendor-id}
{
"auctions": {
"lost": 123,
"percentageWon": 123,
"won": 123
},
"clicks": {
"adSpent": 123,
"charged": 123,
"total": 123
},
"impressions": {
"adSpent": 123,
"charged": 123,
"total": 123
},
"purchases": {
"amount": 123,
"count": 123,
"countByProduct": {},
"quantity": 123
}
}
Path Parameters
The ID of the vendor.
Minimum length:
1
Query Parameters
The start date for which reports will be generated.
The end date for which reports will be generated.
Response
200
application/json
Successful Response
Auctions information attributed to this report item in addition to normal report data.
How many auctions are attributed to this report item.
How many purchases are attributed to this report item.
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.
curl --request GET \
--url https://api.topsort.com/public/v1/reporting-service/vendors/{vendor-id}
{
"auctions": {
"lost": 123,
"percentageWon": 123,
"won": 123
},
"clicks": {
"adSpent": 123,
"charged": 123,
"total": 123
},
"impressions": {
"adSpent": 123,
"charged": 123,
"total": 123
},
"purchases": {
"amount": 123,
"count": 123,
"countByProduct": {},
"quantity": 123
}
}