c301132dbfd7
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.
Query parameters
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, prefixed biz_. Optional for account API keys; required for credentials that can access multiple accounts.
Start of the time range as an ISO 8601 timestamp. Required when identifier is omitted.
End of the time range as an ISO 8601 timestamp. Required when identifier is omitted; otherwise defaults to now.
The number of events to return.
A cursor for fetching events after a previous page.
A cursor for fetching events before a later page.
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.
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.
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 for the source filter (defaults to last_touch).
Country codes to filter by, comma-separated.
Cities to filter by, comma-separated.
Device families to filter by, comma-separated (e.g. iPhone, Mac).
Browser families to filter by, comma-separated (e.g. Chrome, Mobile Safari).
Operating system families to filter by, comma-separated (e.g. iOS, Windows).
utm_source values to filter by, comma-separated.
Page hostnames to filter by, comma-separated.
Page paths to filter by, comma-separated.
Response
events listed oldest first
Example response
{
"data": [
{
"context": {
"ad_campaign_id": "adcamp_xxxxxxxxxxxxxx",
"ad_click_id": "IwAR123",
"ad_click_type": "fbclid",
"ad_id": "ad_xxxxxxxxxxxxxx",
"ad_set_id": "adgrp_xxxxxxxxxxxxxx",
"source_type": "ad_click",
"utm_campaign": "brand",
"utm_content": "creative",
"utm_medium": "paid",
"utm_source": "google",
"utm_term": "keyword"
},
"currency": "usd",
"custom_name": "coating_deposit_paid",
"event_id": "evt_124",
"event_name": "pixel.custom",
"event_time": "2026-01-01T12:00:00.000Z",
"id": "evt_124",
"path": "/checkout/complete",
"person_id": "prsn_123",
"questions": [
{
"answer": "SUV",
"id": "q_2",
"key": "vehicle_type",
"options": [
"Truck"
],
"question": "What vehicle are we detailing?",
"type": "custom"
}
],
"referrer_url": "https://google.com",
"related": {
"account": {
"id": "biz_xxxxxxxxxxxxxx",
"logo_url": "https://assets-2-rough.whop.com/uploads/image/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"route": "biz_xxxxxxxxxxxxxx",
"title": "Shine Time Auto Detailing"
},
"ad": {
"id": "ad_xxxxxxxxxxxxxx",
"thumbnail_url": "https://assets-2-rough.whop.com/uploads/image/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"title": "Ceramic coating — before/after reel"
},
"ad_campaign": {
"id": "adcamp_xxxxxxxxxxxxxx",
"platform": "meta",
"title": "Ceramic coating — spring push"
},
"ad_group": {
"id": "adgrp_xxxxxxxxxxxxxx",
"title": "Austin — SUV owners"
},
"app": {
"domain_id": "whopappdomain0000001",
"icon_url": "https://assets-2-rough.whop.com/uploads/image/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"id": "app_xxxxxxxxxxxxxx",
"title": "Shine Time Booking"
},
"audience": {
"audience_type": "custom",
"file_name": "shine-time-customers.csv",
"id": "adaud_xxxxxxxxxxxxxx",
"source_type": "csv_upload",
"title": "Austin ceramic coating leads"
},
"payment": {
"card_brand": "visa",
"card_last4": "4242",
"id": "pay_xxxxxxxxxxxxxx",
"provider": "stripe"
},
"plan": {
"billing_period": 30,
"currency": "usd",
"id": "plan_xxxxxxxxxxxxxx",
"renewal_price": 59,
"title": "Unlimited Wash Club"
},
"product": {
"id": "prod_xxxxxxxxxxxxxx",
"route": "ceramic-coating-package",
"title": "Ceramic Coating Package"
},
"user": {
"avatar_url": "https://assets-2-rough.whop.com/uploads/image/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"id": "user_xxxxxxxxxxxxxx",
"name": "Dana Whitfield",
"username": "danawhitfield"
}
},
"total_usd_amount": 249,
"url": "https://shinetime.example/checkout/complete",
"user": {
"city": "Austin",
"country": "US",
"email": "marcus@shinetime.example",
"first_name": "Dana",
"last_name": "Whitfield",
"name": "Dana Whitfield",
"phone": "5551234567"
},
"value": 249
}
],
"page_info": {
"end_cursor": "cursor_end",
"start_cursor": "cursor_start"
}
}