Skip to main content
GET
List events
List recorded event occurrences. Event-type configuration is separate: use Events in the console or the Platform API to create labels and weights. Use the filters and pagination below to inspect a user’s or item’s history. A search event can have no item; its query and result IDs describe the search. See Events for the ingestion contract.

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

limit
integer
default:20

Maximum number of resources to return. Defaults to 20 and is capped at 100.

Required range: 1 <= x <= 100
starting_after
string

Cursor from a previous event list response.

Pattern: ^[1-9][0-9]*$
user_id
string

Filter to events recorded for one end-user ID.

type
string

Filter to one event type, such as click or purchase.

Response

Paginated event list

object
enum<string>
required
Available options:
list
data
object[]
required
has_more
boolean
required
url
string
required
next_cursor
string | null