Report events

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"
    }
  ]
}'

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/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.

POST

events

Report events

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"
    }
  ]
}'

This response does not have an example.

Authorizations

Authorization

string

header

required

A valid API key generated in Topsort's UI.

Body

application/json

Response

204

All events were reported successfully.

Create travel auctions [Beta] Report Link Users

General

Auction examples

Asset examples

Webhook examples

Auctions

Events

Toptimize

Assets API

Billing API

Campaign API

Catalog API

Invitation API

Media API

Offsite Ads API

Reporting API

Segments Service

Toppie API

Forecasting Service

User API

Webhooks API

API Reference

Report events

Authorizations

Body

Response