import type * as Whop from "../../../../index.js"; /** * @example * { * source: ["direct"], * event_name: ["payment.completed"] * } */ export interface ListPeopleRequest { /** Account ID, prefixed `biz_`. Optional for account API keys; required for credentials that can access multiple accounts. */ account_id?: string; /** Search people by name, email, phone, or whop user ID (case-insensitive substring match). */ query?: string; /** Only include people acquired from any of these sources — canonical paths (whop:::, ext::..., referrer:, direct, other), exact or with a trailing :* prefix. The same vocabulary the events / people metrics use. */ source?: string | string[]; /** Attribution model the source filter matches against (defaults to last_touch). */ attribution_model?: Whop.ListPeopleRequestAttributionModel; /** Only include people who fired any of these events, e.g. payment.completed or page.checkout.view. */ event_name?: string | string[]; /** Only include people who fired this custom pixel event. */ custom_event?: string; /** Match activity within a rolling number of days. Cannot be combined with event_from/event_to. */ event_within_days?: number; /** Inclusive activity-window start. Alias for event_from. */ from?: string; /** Inclusive activity-window end. Alias for event_to. */ to?: string; /** The inclusive start of the matching activity window. */ event_from?: string; /** The inclusive end of the matching activity window, for both stats drilldowns and saved audiences. */ event_to?: string; /** Only include people in this audience. An audience that keeps itself up to date resolves to the People filters that define it, so this always reflects who matches now; uploaded lists and point-in-time snapshots match their recorded members. */ audience_id?: string; /** Only include the person linked to this whop user ID. */ user_id?: string; /** Only include the person linked to this email address. */ email?: string; /** Only include the person linked to this phone number. */ phone?: string; /** Only include people with activity from this ISO 3166-1 alpha-2 country code. */ country?: string; /** true for customers only, false for people who have never purchased. */ has_purchased?: boolean; /** true for people who have an email address or phone number — the ones an ad platform can match. */ contactable?: boolean; /** Only include people first seen within this many days, as a rolling window. */ first_seen_within_days?: number; /** Only include people last seen within this many days, as a rolling window. */ last_seen_within_days?: number; /** Only include people first seen at or after this ISO 8601 timestamp. */ first_seen_after?: string; /** Only include people first seen before this ISO 8601 timestamp. */ first_seen_before?: string; /** Only include people last seen at or after this ISO 8601 timestamp. */ last_seen_after?: string; /** Only include people last seen before this ISO 8601 timestamp. */ last_seen_before?: string; /** Select people whose lifetime ltv is greater than this value. LTV and AOV are in USD. */ ltv_gt?: number; /** Select people whose lifetime ltv is at least this value. LTV and AOV are in USD. */ ltv_gte?: number; /** Select people whose lifetime ltv is less than this value. LTV and AOV are in USD. */ ltv_lt?: number; /** Select people whose lifetime ltv is at most this value. LTV and AOV are in USD. */ ltv_lte?: number; /** Select people whose lifetime aov is greater than this value. LTV and AOV are in USD. */ aov_gt?: number; /** Select people whose lifetime aov is at least this value. LTV and AOV are in USD. */ aov_gte?: number; /** Select people whose lifetime aov is less than this value. LTV and AOV are in USD. */ aov_lt?: number; /** Select people whose lifetime aov is at most this value. LTV and AOV are in USD. */ aov_lte?: number; /** Select people whose lifetime purchase_count is greater than this value. LTV and AOV are in USD. */ purchase_count_gt?: number; /** Select people whose lifetime purchase_count is at least this value. LTV and AOV are in USD. */ purchase_count_gte?: number; /** Select people whose lifetime purchase_count is less than this value. LTV and AOV are in USD. */ purchase_count_lt?: number; /** Select people whose lifetime purchase_count is at most this value. LTV and AOV are in USD. */ purchase_count_lte?: number; /** Select people whose lifetime event_count is greater than this value. LTV and AOV are in USD. */ event_count_gt?: number; /** Select people whose lifetime event_count is at least this value. LTV and AOV are in USD. */ event_count_gte?: number; /** Select people whose lifetime event_count is less than this value. LTV and AOV are in USD. */ event_count_lt?: number; /** Select people whose lifetime event_count is at most this value. LTV and AOV are in USD. */ event_count_lte?: number; /** Number of results to return from the start of the range. */ first?: number; /** Return results after this cursor. Use `page_info.end_cursor` from the previous response to fetch the next page. */ after?: string; /** Return results before this cursor. Use `page_info.start_cursor` from the previous response to fetch the previous page. */ before?: string; /** Column to sort by. Defaults to last_seen_at. */ order?: Whop.ListPeopleRequestOrder; /** Sort direction. Defaults to desc. */ direction?: Whop.ListPeopleRequestDirection; }