Authorizations
A valid API key generated in Topsort's UI.
Body
application/json
Response
All events were reported successfully.
Auction examples
Asset examples
Webhook examples
Assets API
Billing API
- GETGet Billing Contacts
- GETGet Billing Contact
- PUTUpsert Billing Contact
- GETGet Campaign Billing Contact
- PUTUpsert Campaign Billing Contact
- GETGet Marketplace Credit Limitdeprecated
- POSTSet Marketplace Credit Limitdeprecated
- PUTUpsert Vendor Billing Contact
- GETGet Vendor Chargesdeprecated
- GETGet Vendor Account Activitydeprecated
- GETGet Vendor Balance
- POSTAdd Vendor Balance
- POSTBurn Vendor Balance
- GETGet Vendor Credit Historydeprecated
- GETGet Vendor Credit Limitdeprecated
- POSTSet Vendor Credit Limitdeprecated
- DELDelete Vendor Billing Contact
- GETGet Vendor Wallets
- POSTCreate Wallet
- POSTAdjust Wallet Balance
Campaign API
- GETGet Campaigns
- POSTCreate Campaign
- POST[BETA] Create exclusive banner campaign.
- GET[BETA] Get exclusive banner campaign by ID.
- PATCH[BETA] Update exclusive banner campaign by ID.
- POST[BETA] Create exclusive listing campaign.
- GET[BETA] Get exclusive listing campaign by ID.
- PATCH[BETA] Update exclusive listing campaign by ID.
- 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
- GETGet Campaign Restriction
- POSTCreate Campaign Restriction
- PATCHUpdate Campaign Restriction
- POST[BETA] Get estimated clicks of a future campaign for a given vendordeprecated
- GETGet Json Templates
- POSTCreate Json Template
- GETGet Json Template
- PATCHUpdate Json Template
- GETGet Products In Campaign
- GETGet Restriction Types
- GETGet Restriction Type
- GETGet Sponsored Productsdeprecated
Catalog API
Invitation API
Offsite Ads API
- PUTUpsert Advertiser Domain
- POSTCreate a new advertiser
- GETGet advertiser onboarding state for a specific DSP
- GETList Audiences
- POST[BETA] Create offsite audience job.
- GETGet vendor offsite campaigns
- POSTCreate Campaign
- GETGet campaign information
- PATCHUpdate Campaign
- GETGet Job Status
- GETGet Campaign Aggregated Report
- GETGet Campaign Daily Report
- GETGet Campaign Products Report
Reporting API
- GETGet Campaign Report
- GETGet Campaign Daily Report
- GETGet Campaign Report By Product
- GETGet Product Report
- GETGet Product Daily Report
- GETGet Interactions Dump Urls
- GETGet Scored Attribution Dump Urls
- 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 Toppie Campaigns
- POST[BETA] Create Toppie Campaign
- GET[BETA] Get Toppie Campaign Details
- DEL[BETA] Delete Toppie Campaign
- PATCH[BETA] Update Toppie Campaign
- GET[BETA] Get Toppie Campaign Bids
- GET[BETA] List Account Products
- GET[BETA] Get Agency Account Report.
- GET[BETA] Account Activity Reports.
- GET[BETA] Get Campaigns Reporting.
- GET[BETA] Get Campaign Report.
- GET[BETA] Get Campaign Products Report.
- GETGet Agency Daily Kpis By Product Dump Urls
Forecasting Service
API Reference
Report events
Copy
Ask AI
curl --request POST \
--url https://api.topsort.com/v2/events \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"impressions": [
{
"id": "eb874c98-bf4d-40a9-ae6d-fcf4cecb535c",
"occurredAt": "2019-01-01T12:59:59-05:00",
"opaqueUserId": "71303ce0-de89-496d-8270-6434589615e8",
"placement": {
"path": "/categories/dairy",
"position": 1,
"page": 1,
"pageSize": 15,
"categoryId": "9BLIe"
},
"resolvedBidId": "WyJiX01mazE1IiwiMTJhNTU4MjgtOGVhZC00Mjk5LTgzMjctY2ViYjAwMmEwZmE4IiwibGlzdGluZ3MiLCJkZWZhdWx0IiwiIl0=",
"deviceType": "mobile",
"channel": "onsite"
}
]
}'Copy
Ask AI
This response does not have an example.Events
Report events
Use the /events endpoint to report user interactions and activity in on a marketplace:
- Impressions — a user viewed an asset.
- Clicks — a user clicked on an asset.
- Purchases — a user created an order.
- Pageviews — a user visited a page.
Interactions require either a
resolvedBidId, for sponsored events coming from the/v2/auctionsresponse, or anentitythat describes the entity that was interacted with, in the case of organic or non-sponsored events. For analytics purposes, you can use theplacementfield to differentiate different listings or banners. For example, on a product page with a carousel of products, you can track impressions and clicks related to the carousel by including/carouselat the end of thepathfield in theplacementobject. This allows you to monitor the performance of carousel products in the Data Room.
POST
/
v2
/
events
Report events
Copy
Ask AI
curl --request POST \
--url https://api.topsort.com/v2/events \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"impressions": [
{
"id": "eb874c98-bf4d-40a9-ae6d-fcf4cecb535c",
"occurredAt": "2019-01-01T12:59:59-05:00",
"opaqueUserId": "71303ce0-de89-496d-8270-6434589615e8",
"placement": {
"path": "/categories/dairy",
"position": 1,
"page": 1,
"pageSize": 15,
"categoryId": "9BLIe"
},
"resolvedBidId": "WyJiX01mazE1IiwiMTJhNTU4MjgtOGVhZC00Mjk5LTgzMjctY2ViYjAwMmEwZmE4IiwibGlzdGluZ3MiLCJkZWZhdWx0IiwiIl0=",
"deviceType": "mobile",
"channel": "onsite"
}
]
}'Copy
Ask AI
This response does not have an example.Was this page helpful?
⌘I