Report events
Use the /events endpoint to report user interactions and activity in on a marketplace:
- Renders — an ad was rendered in the page.
- Impressions — a user viewed an asset.
- Clicks — a user clicked on an asset.
- Purchases — a user created an order.
- Page views — a user visited a page.
Interactions require either a resolvedBidId, for sponsored events coming from the /v2/auctions response, or an entity that describes the entity that was interacted with, in the case of organic or non-sponsored events. For analytics purposes, you can use the placement field 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 /carousel at the end of the path field in the placement object. This allows you to monitor the performance of carousel products in the Data Room.
Request
- Base URL: https://api.topsort.com
- URL: https://api.topsort.com/v2/events
- Auth: HTTP bearer
Request body
Example request
{
"renders": [
{
"id": "3f2b9c14-7a1d-4e2b-9c3a-1b2c3d4e5f60",
"occurredAt": "2019-01-01T12:59:58-05:00",
"opaqueUserId": "71303ce0-de89-496d-8270-6434589615e8",
"resolvedBidId": "WyJiX01mazE1IiwiMTJhNTU4MjgtOGVhZC00Mjk5LTgzMjctY2ViYjAwMmEwZmE4IiwibGlzdGluZ3MiLCJkZWZhdWx0IiwiIl0=",
"placement": {
"path": "/categories/dairy",
"position": 1,
"page": 1,
"pageSize": 15,
"categoryIds": [
"9BLIe"
]
},
"deviceType": "mobile",
"channel": "onsite"
}
]
}Response
All events were reported successfully.
Changes
No recorded changes to this operation across all 1 revision of this API.