Skip to main content
POST
/
v2
/
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,
        "categoryIds": [
          "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

Event data including impressions, clicks, purchases, and page views.

A batch request containing multiple events to be reported to Topsort.

​
impressions
Impression · object[]

An array of impression events

Maximum length: 50
​
clicks
Click · object[]

An array of click events

Maximum length: 50
​
purchases
Purchase · object[]

An array of purchase events

Maximum length: 50
​
pageviews
Page View · object[]

An array of page views

Maximum length: 50

Response

All events were reported successfully.