Events

List Events

Lists identity-linked events, most recent first. Pass identifier for one person's journey, or omit it to list events for an account within an explicit time range. 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

The ID of the account, which will look like 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.

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

account events listed

Changes