v8

OpenAPI 3.1.02026-08-033623795.0 MB

Events

List Events

Lists identity-linked events, most recent first by default. Pass identifier for one person's journey, or omit it to list events for an account within an explicit time range. Pass direction=asc to read a journey forwards from where it starts. Events are shaped like the POST /events intake: attribution in context, identity in user.

get/events

Query parameters

identifierstring

Any hard identifier of the person: a person ID (prsn_*), user ID, email, phone number, or a tracking cookie value (wuid, anonymous ID, fbp/fbc/ttp/ga). Omit to list recent events for the account.

account_idstring

Account ID, prefixed biz_. Optional for account API keys; required for credentials that can access multiple accounts.

fromstring date-time

Start of the time range as an ISO 8601 timestamp. Required when identifier is omitted.

tostring date-time

End of the time range as an ISO 8601 timestamp. Required when identifier is omitted; otherwise defaults to now.

firstinteger

The number of events to return.

afterstring

A cursor for fetching events after a previous page.

beforestring

A cursor for fetching events before a later page.

direction'asc' | 'desc'

The order events are returned in by time. Defaults to desc (most recent first); asc reads a journey forwards from where it starts. after and before always page forwards and backwards through that order.

eventstring

Full event names to filter by, comma-separated (payment.completed, pixel.lead, pixel.page, pixel.custom:<name>) — the same vocabulary the events / people metrics use.

sourcestring

Canonical source path, exact or with a trailing :* prefix (whop:<campaign>:, ext:meta:, referrer:<domain>, direct). Restricts the list to conversion targets attributed to that source — the debuggability twin of a metric cell's source parameter.

attribution_model'last_touch' | 'first_touch'

Attribution model for the source filter (defaults to last_touch).

countrystring

Country codes to filter by, comma-separated.

citystring

Cities to filter by, comma-separated.

devicestring

Device families to filter by, comma-separated (e.g. iPhone, Mac).

browserstring

Browser families to filter by, comma-separated (e.g. Chrome, Mobile Safari).

osstring

Operating system families to filter by, comma-separated (e.g. iOS, Windows).

utm_sourcestring

utm_source values to filter by, comma-separated.

hostnamestring

Page hostnames to filter by, comma-separated.

pagestring

Page paths to filter by, comma-separated.

Response

events listed oldest first