Skip to main content
GET
JavaScript

Authorizations

Authorization
string
header
required

An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************.

Query Parameters

identifier
string

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_id
string

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

from
string<date-time>

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

to
string<date-time>

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

first
integer

The number of events to return.

after
string

A cursor for fetching events after a previous page.

before
string

A cursor for fetching events before a later page.

direction
enum<string>
default: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.

Available options:
asc,
desc
event
string

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

source
string

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

attribution_model
enum<string>

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

Available options:
last_touch,
first_touch
country
string

Country codes to filter by, comma-separated.

city
string

Cities to filter by, comma-separated.

device
string

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

browser
string

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

os
string

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

utm_source
string

utm_source values to filter by, comma-separated.

hostname
string

Page hostnames to filter by, comma-separated.

page
string

Page paths to filter by, comma-separated.

Response

events listed oldest first

data
object[]
required
page_info
object
required