> ## Documentation Index > Fetch the complete documentation index at: https://docs.whop.com/llms.txt > Use this file to discover all available pages before exploring further. > ## Agent Instructions > Treat these docs and the Whop MCP server as the source of truth for Whop API behavior. Don't infer endpoint behavior from marketing pages. > MCP server: connect https://mcp.whop.com/mcp (streamable HTTP, browser sign-in, no API key in the client config) to search these docs and read or change live Whop data. Setup: https://docs.whop.com/developer/guides/ai_and_mcp.md > Whop CLI: install with `curl -fsSL https://whop.com/install.sh | sh` to scaffold, run, and deploy Whop apps and websites. It acts on production, not the sandbox. Agent mode: https://docs.whop.com/cli/agent-mode.md > Plugins: in Claude Code, run `/plugin marketplace add whopio/plugins`, then `/plugin install whop@whop`. Every agent tool: https://docs.whop.com/developer/ai/overview.md > Environments: build and test in the sandbox (API `https://sandbox-api.whop.com/api/v1`, keys at https://sandbox.whop.com/dashboard/developer, SDK environment `Sandbox`; no real money). Production (API `https://api.whop.com/api/v1`, keys at https://whop.com/dashboard/developer, SDK environment `Production`, the SDK default) moves real money, so use it only at launch. The two share no accounts, keys, products, or webhooks, and their keys look identical: never mix them. Comparison: https://docs.whop.com/developer/quickstart.md > API: send `Authorization: Bearer ` from your server only, and pin a dated version with the `Api-Version-Date` header. OpenAPI spec: https://api.whop.com/api/v1/openapi.json > Which API: build on the Current API, whose pages live under https://docs.whop.com/api-reference/ (start at https://docs.whop.com/api-reference/overview.md). Pages under /api-reference/legacy/ are the Legacy API. Use one only when https://docs.whop.com/api-reference/stability.md lists the resource as Legacy-only. # Retrieve Metric Time Series > Retrieves a metric as a series of points over a time range for an account or user. For an aggregate that is not bucketed over time, use a report from `GET /stats/reports`. The `market_prices` metric is public and requires no authentication. ## OpenAPI ````yaml /openapi/api-v1-native.json get /stats/time_series/{metric} openapi: 3.1.0 info: description: >- The Whop REST API. Please see https://docs.whop.com/developer/api/getting-started for more details. termsOfService: https://whop.com/tos-developer-api/ title: Whop API version: 1.0.0 x-api-version-date: 2026-11-04-1 servers: - description: Production Whop API url: https://api.whop.com/api/v1 - description: Sandbox Whop API url: https://sandbox-api.whop.com/api/v1 security: [] tags: - description: > An Account represents a person or business on Whop that can have its own profile, wallet, and account-scoped settings. Use accounts for customers, creators, merchants, sellers, or connected businesses your integration supports. Use the Accounts API to create accounts, list accounts visible to your credentials, retrieve or update an account, suspend or delete a subaccount managed by your platform, and retrieve the account associated with the current API key. name: Accounts x-whop-summary: 'A business on Whop: profile, wallet, capabilities, settings.' - description: > A User represents a person on Whop. Users have a public profile and can buy products, join accounts, and access experiences. Use the Users API to search for users, retrieve or update profiles, and check whether a user has access to an account, product, or experience. name: Users x-whop-summary: 'A person on Whop: profile and connected identities.' - description: > A Member is one buyer's relationship with an account: one record per customer, however many memberships they hold. It tracks whether they have joined or left, their access level, and when they last opened the account's content. Use the Members API to list and search an account's members, retrieve a single member, and read a member's activity log. Member rows are created and maintained by the membership lifecycle; to grant or revoke access, work with memberships instead. name: Members x-whop-summary: One buyer's relationship with an account, across all their purchases. - description: > A Team Member is a member of an account's team: the link between a user and an account, carrying the role that controls what they can do. Roles are either system roles (like `admin` or `moderator`) or `custom` roles managed from the dashboard. Use the Team Members API to list an account's team, add a user to the team with a system role, change a member's role, and remove members. Adding a user who has not yet accepted sends an invitation instead. name: Team Members x-whop-summary: An account's team members and the roles that scope their access. - description: > Search finds one account's records in one call: members, memberships, payments, affiliates, reviews, resolution center cases, promo codes and accounts. A pasted identifier finds its records exactly and they come first, ahead of ranked text matches. Use the Search API behind a search box or a command menu over an account's data: find the customer behind an email or a card, open a payment from its ID or invoice number, or jump to a member by name. To filter one resource and page through every match, use that resource's list endpoint instead. name: Search x-whop-summary: >- Find an account's members, payments and other records in one call, by ID, email, card, phone, number, link or text. - description: > An External Account represents an account on another platform linked to a Whop account or user, such as a Facebook page, Instagram account, TikTok account, or Klaviyo account. You connect it through OAuth or an API key, or Whop creates it for you. External account IDs are prefixed `sacc_`. Use the External Accounts API to list connected accounts, [connect a profile through OAuth](/api-reference/external-accounts/connect-an-external-account), [create a Whop-managed Facebook page or TikTok account, or connect a Klaviyo account with its API key](/api-reference/external-accounts/create-an-external-account), and disconnect an external account. name: External Accounts x-whop-summary: Accounts on other platforms linked to an account or user. - description: > Social Accounts is the former public name for External Accounts. Existing integrations can keep calling these deprecated endpoints while they migrate; every response points to the matching External Accounts endpoint. Use the External Accounts API for all new integrations. External account IDs keep their `sacc_` prefix, and the underlying resource is unchanged. name: Social Accounts x-whop-summary: Deprecated compatibility endpoints for external accounts. - description: > A Payment is one charge against a buyer, for one or more variants. Create an on-session payment with a `confirmation_token` for the method the buyer selected, or an off-session payment with an existing member's stored payment method. Use the Payments API to charge buyers, list and retrieve payments, and refund, void, capture, or retry them. Collection runs in the background, so the create response is not the outcome. Poll [Retrieve status](/api-reference/payments/retrieve-payment-status) for how far the payment has gone and, while it is `requires_action`, what the buyer must do next: follow a redirect, complete 3D Secure, display transfer instructions, or link a bank account. Update the payment's `return_url` to change where they land afterwards, up until they come back. name: Payments x-whop-summary: A charge against a buyer, and the step they still owe. - description: > An Invoice is a receipt with an invoice number. Create a draft from variant-backed items, set its recipient and due date, and edit it until it is sent. Its `pay_` ID is also the payment ID when collected. Draft creation does not create access or charge the buyer. The recipient's contact details live on the account's member. Financial fields and caller metadata can only be edited in draft. name: Invoices x-whop-summary: >- A payment request that keeps the same receipt from draft through collection. - description: > A Confirmation Token is a single-use, short-lived reference to a payment method and billing details collected from a buyer. Its response never returns the underlying payment credential. Whop Elements mint the token in your buyer-facing collection flow and hand you its `ctok_` ID to send to the Payments API from your server. Retrieve a token to display its payment method and billing preview or check whether it is still usable. name: Confirmation Tokens x-whop-summary: A short-lived reference to payment details collected from a buyer. - description: > A Payment Quote prices a purchase exactly as a payment for it will be charged: the same line pricing, promo code, and tax, for a buyer located by the address, country, or IP address you send. A quote is priced once, can be consumed by one payment, and expires. Use the Payment Quotes API to show a buyer the total, tax, and currency before they pay, then pass the quote's `id` as `quote_id` when you create the payment to charge exactly that quote. Quote again whenever the cart, promo code, or address changes. name: Payment Quotes x-whop-summary: 'A purchase priced before it is paid: its lines, promo code and tax.' - description: > A Setup Intent saves a buyer's payment method for later without taking money now. Create one from a confirmation token the payment elements collected in setup mode, or from a payment method already on file to re-verify it. It runs the same collection flow a payment does, so the buyer may still owe a step: 3D Secure on a card, a hosted enrollment, or linking a bank account. The create response is the setup intent as created, not its outcome. Hand its `client_secret` to the elements' `handleNextAction`, or poll [Retrieve status](/api-reference/setup-intents/retrieve-setup-status) for how far the setup has gone and what is outstanding. Once it reaches `succeeded`, `payment_method_id` names the saved method and Create Payment charges it. name: Setup Intents x-whop-summary: Saving a buyer's payment method without charging it. - description: > A Refund is one full or partial reversal of a payment, issued with [Refund Payment](/api-reference/payments/refund-payment). It records how much moved, through which provider, and whether it succeeded. Use the Refunds API to list the refunds on a payment or across an account, and to retrieve a single refund. name: Refunds x-whop-summary: Money returned to a buyer from a payment. - description: > A Resolution Center Case is opened by a buyer when something is wrong with a purchase, such as an unwanted renewal, an item that never arrived, or a charge they don't recognize. It is the step before a chargeback: the buyer and merchant work it out directly, and Whop decides the case if they can't. Use the Resolution Center Cases API from either side: as the buyer, open, reply to, appeal, or withdraw a case; as the merchant, accept it (refunding the payment), deny it, or ask the buyer for more information. name: Resolution Center Cases x-whop-summary: File or respond to a case against a payment, as the buyer or the merchant. - description: > A Dispute alert is an early warning from a card issuer that a settled payment is being questioned, ahead of any chargeback. `type` separates fraud reports (`early_fraud_warning`), pre-dispute notices (`dispute_alert`), and Visa RDR cases the network already closed by refunding (`rapid_dispute_resolution`). Use the Dispute alerts API to list alerts for an account, filter them by type or payment, and read `actionable` to see whether refunding can still avoid the chargeback. name: Dispute alerts x-whop-summary: Issuer warnings that arrive before a chargeback does. - description: > A Dispute is a chargeback a customer files against a payment through their bank, or an inquiry that may become one. It carries the disputed payment, a deadline to respond, your evidence, and the outcome once the processor rules. Use the Disputes API to list disputes, edit the evidence packet while a dispute is still contestable, and submit it for review, or accept a chargeback you don't want to contest. name: Disputes x-whop-summary: Chargebacks filed against an account, with evidence and outcomes. - description: > A Payment Rule lets an account act on its own payments before they reach the bank: block them, let them through, send them to review, or ask the buyer for 3D Secure. Each rule matches on a small set of payment attributes, and every condition must hold for it to apply. A rule's definition is fixed once created, so the payments it decided keep naming the rule that decided them. Use [Replace](/api-reference/payment-rules/replace-a-payment-rule) to change one, and [List fields](/api-reference/payment-rules/list-fields) for the attributes, operators and values a condition can use. name: Payment Rules x-whop-summary: Rules an account writes to decide its own payments. - description: > To accept payment-financing methods, an account applies through a financing application: a request to review the account for payment financing, not a loan or business capital. Create an application, save answers to its requirements, then submit it for review. You can manage applications for your own account and its direct subaccounts. name: Financing Applications x-whop-summary: An account's request to accept buy-now-pay-later payment methods. - description: > Deposits describe the ways to add funds to an account or user balance: a hosted deposit page, bank transfer instructions, and crypto wallet addresses. Use the Deposits API to get deposit instructions for an account or user, such as a crypto address to send funds to or bank details for a transfer. name: Deposits x-whop-summary: Add funds to a balance. - description: > A Transfer moves money between Whop balances: from one account or user to another, from an account's wallet to a person or address, or into a claim link anyone with the URL can redeem. Use the Transfers API to send money, find recipients you can pay, list and retrieve transfers when reconciling money movement, and preview or redeem claim links. Subscribe to `transfer.completed` and `transfer.failed` for outcomes instead of polling. Each participating account can subscribe to these events. `transfer.created` is also emitted on success, not when processing starts. A failed transfer can be retried under the same ID and later succeed; retrieve the transfer to reconcile its current status. A successful balance transfer credits the recipient's available balance unless a release date applies. Transfers funded from pending balance retain a release date and credit pending balance; applicable recipient reserves or fraud holds can keep funds unavailable. `succeeded` confirms the transfer completed, not that all funds are withdrawable. name: Transfers x-whop-summary: Move funds between Whop accounts and users. - description: > Payouts represent money sent from an account or user balance to an external destination, such as a bank account, wallet, or other saved payout method. Use the Payouts API to create and track payouts, manage saved payout methods, and show expected arrival details for funds leaving Whop. name: Payouts x-whop-summary: Send money from a balance to a bank or wallet. - description: > A Financial Activity row is a single movement of money in or out of an account's or user's balance: a payment, payout, refund, transfer, on-chain deposit, swap, or card transaction. Each row carries a typed `resource` and `source` so you can present and link the event without extra lookups. Use the Financial Activity API to build a statement or transaction feed for an account or user, and financial reports to summarize balance activity, income, and balances over a date range, then break a report total down into what drove it. name: Ledgers x-whop-docs-title: Financial Activity x-whop-summary: The activity feed behind an account or user's balance. - description: > Cards represent virtual payment cards that spend from an account or user balance. Cards can be assigned to cardholders and configured with spending limits for controlled spending. Use the Cards API to issue cards, list cards for an account or user, retrieve active card details such as the card number and CVC, and list the transactions made with them. name: Cards x-whop-summary: Issue cards that spend from a balance. - description: > A Cashback Rule pays a platform's direct subaccounts back a share of their card spend, funded by the platform. Each rule sets a rate, an eligibility window, and optional merchant filters, and can be limited to one subaccount. Use the Cashback Rules API to create, update, and list the rules your platform funds, then pay out cashback on demand from your available USD balance. name: Cashback Rules x-whop-summary: Configure platform-sponsored card cashback. - description: > A Swap converts value between supported tokens, chains, or wallet destinations, or between fiat currencies at the mid-market rate, for an account or user. A swap quote previews the expected output, fees, and approval requirements before you create the swap. Use the Swaps API to quote a conversion, create the swap, list recent swaps, and retrieve a swap's status until it completes. name: Swaps x-whop-summary: Convert a balance between currencies. - description: > A Trade is one request on an account's or user's Whop-managed wallet. An `order` on a perpetual trades from the trading balance, bridging the USDT0 it needs from the wallet first when the balance is short; an `order` on spot swaps between USDT0 and the asset in the wallet. A `close` closes the whole position in one market; when the account is then flat, a `withdraw` trade sends the trading balance back to the wallet. A `deposit` or `withdraw` moves money between the wallet and the trading balance. Perpetuals trade on Hyperliquid. Use the Trades API to list the markets you can trade, place orders, close positions and move funds, and follow each trade until it finishes. Trades run in the background; an order that bridged money in and does not fill sends that money back to the wallet, and `funds_location` says where the money is. The trading API, including `include_trading` on accounts and users, is in beta. It can change without a new API version date. name: Trades x-whop-summary: >- Place orders, close positions, and move funds for perpetual and spot trading from a Whop-managed wallet. - description: > A Verification represents a legal identity for a person or business. Accounts and users complete verification when Whop needs to confirm who they are before enabling payouts or compliance-sensitive workflows. Use the Verifications API to start or resume a hosted verification session, check review status, and submit requested details or documents. If `requested_information` contains items, submit answers with [Update Verification](/api-reference/verifications/update-verification). name: Verifications x-whop-summary: Legal identity required before payouts and card issuing. - description: > A Product is a digital good or service sold on Whop. Products contain variants for pricing and may contain experiences for content delivery. Use the Products API to search the public marketplace, list an account's products, retrieve a product, and create, update, or delete products. name: Products x-whop-summary: The things you sell. Each owns variants and a store page. - description: > A Variant is one purchasable configuration of a product. It controls price, billing cadence, stock, SKU, attributes, tax behavior, checkout fields, and purchase visibility. Variant IDs remain prefixed `plan_`. Use the Variants API to create variants for products, list existing variants, retrieve or update variant configuration, calculate tax for checkout, and delete variants that should no longer be offered. name: Variants x-whop-summary: Purchasable configurations of a product. - description: > A Promo Code is a discount a buyer enters at checkout, either a percentage or a fixed amount off. It belongs to an account, can be limited to one product, and controls who can redeem it, how many times, until when, and for how many billing periods the discount lasts. Use the Promo Codes API to create codes for an account, list and retrieve them, deactivate a code to pause redemptions or activate it again, and archive codes you no longer offer. name: Promo Codes x-whop-summary: Discounts that creators configure for checkout. - description: > A Checkout Configuration is a reusable checkout link owned by an account. In `payment` mode it sells a specific variant; in `setup` mode it collects and saves payment details without charging. Each configuration can also override which payment methods are accepted and how 3D Secure is enforced for that checkout. Use the Checkout Configurations API to create checkout links for an existing or inline variant, list configurations for an account, retrieve the configuration behind a checkout URL, and delete links that should no longer be used. name: Checkout Configurations x-whop-summary: Turn a variant into a shareable, prefilled checkout link. - description: > A Waitlist Entry is a user's signup for a variant that requires seller approval. Joining doesn't grant a membership or charge a payment method; the seller approves or denies each signup. Use the Waitlist Entries API to join a waitlist, read or cancel your own signups, and approve or deny the signups for accounts you operate. name: Waitlist Entries x-whop-summary: Join waitlists and manage customer signups awaiting approval. - description: > A Membership is a customer's purchase of a variant: the subscription or one-time grant that gives them access to a product. It tracks billing state (`active`, `trialing`, `past_due`, and so on), the current period, pending cancellations, custom metadata, and the software license key when the product includes licensing. Use the Memberships API to list an account's memberships or your own, retrieve one by ID or license key, invite a recipient to join through a free variant, and manage the lifecycle: cancel immediately or at period end, reverse a scheduled cancellation, pause and resume payment collection, extend or reactivate access, apply a promo code or affiliate, change renewal cadence, resync access, generate a transfer link, and update metadata. name: Memberships x-whop-summary: A customer's purchase of a variant, from checkout through cancellation. - description: > A Shipment attaches a carrier tracking number to a payment and follows the package from label creation to delivery, exposing the current delivery status and a customer-facing tracking URL. Use the Shipments API to list an account's shipments, retrieve one by its ID or the payment it fulfills, attach a tracking number to a payment, and update the tracking number on an existing shipment. name: Shipments x-whop-summary: Track the delivery of an order by its carrier tracking number. - description: > A Review is a customer's star rating and optional written feedback on a product, shown on the product's store page. Use the Reviews API to list a product's reviews, filtered by star rating or creation date, and retrieve a review by ID. name: Reviews x-whop-summary: Customer star ratings and written feedback on a product. - description: > A Review Report is a request from an account's admins for Whop staff to review a customer's review. Staff remove the review if it breaks the guidelines. Use the Review Reports API to list the reports filed on an account's reviews, narrowed by review, status, or creation date, and check whether a report is still pending. name: Review reports x-whop-summary: Reports an account's admins filed against customer reviews. - description: > A Product Affiliate represents a user's enrollment in a product's affiliate program. An enrollment can exist before the user makes a referral or earns a reward. Use the Product Affiliates API to list product affiliates for an account, search by affiliate name or username, and narrow the results by product, enrollment status, or signup date. name: Product Affiliates x-whop-summary: >- Users enrolled to promote a product, including affiliates with no referrals. - description: > A Domain is a hostname an account holds on Whop. Its capabilities set what Whop does with it: `registration` buys the domain through Whop, runs its DNS, and renews it every year; `verification` connects a domain registered elsewhere once you publish the DNS records it returns, and expires if ownership is not proven within 48 hours; `website` serves one of the account's apps on it. Use the Domains API to search for a domain to buy, buy or connect one, serve a website on it, and check its DNS, payment, and renewal state. Thirty days before a bought domain expires, Whop opens a renewal charge at `purchase_url` and, while `auto_renew` is on, charges the saved card. An unpaid domain stops serving when it expires but stays renewable at `purchase_url` until the registry's grace period ends, and is then removed. name: Domains x-whop-summary: Custom domains assigned to hosted apps. - description: > An App is software you build on Whop. It can be a hosted web app served at its domains, such as a `whop.site` address or a custom domain, or an API integration installed as an experience, and it belongs to the account that owns its credentials, settings, builds, and runtime logs. Use the Apps API to manage app configuration, deploy an app's working copy and follow the run on the app's `deployment` field, and, for hosted apps, read server runtime logs for console output, uncaught exceptions, and failed requests. Apps are also reusable blueprints. List official blueprints with `app_type=website&verified=true&order=template_usage`, or community blueprints with `app_type=website&verified=false&recommended=true&order=template_usage`. Pass the returned App `id` as `blueprint_id` when creating an Account. name: Apps x-whop-summary: 'Apps you build on Whop: metadata, hosted builds, runtime logs.' - description: > An App Build is a versioned artifact uploaded for an app — a hosted web archive, or an iOS/Android bundle. Builds start as drafts, go through review, and one approved build per platform is served to users as the production build. Use the App Builds API to upload a build for an app, list an app's builds with platform and status filters, retrieve a build, and promote a draft or approved build to production. name: App Builds x-whop-summary: Versioned build artifacts deployed to an app's platforms. - description: > An App Installation represents one install of your app on one account. An account installs an app once, however many experiences it adds, so an installation holds state that belongs to the account rather than to one experience, such as a sync cursor or the ID of the account it's linked to in another system. Use the App Installations API to [list the accounts your app is installed on](/api-reference/app-installations/list-app-installations), [retrieve one](/api-reference/app-installations/retrieve-app-installation), and [update](/api-reference/app-installations/update-app-installation) the `metadata` and `external_id` your app keeps on it. An account can also list the apps installed on it, and a developer every installation of their app. Only the app and its developer see `metadata` and `external_id`, and only the app can change them. name: App Installations x-whop-summary: >- Your app's installations on accounts, and the data it keeps about each one. - description: > An Experiment is a feature flag or A/B test owned by an account. Treatments take stable percentage ranges of traffic and everyone else gets control, so growing an allocation never moves an existing user to another arm. Use the Experiments API to create a draft, configure its weights, targeting, and resource bindings, then activate, pause, or end it, and to evaluate which arm a user, account, or anonymous visitor gets. Managing experiments requires `experiment:read` or `experiment:manage`; evaluation works without authentication. name: Experiments x-whop-summary: Feature flags and A/B experiments for gradual rollout. - description: > An Ad Campaign is the top-level container for paid ads. It sets the objective and budget strategy shared by its [ad groups](/api-reference/ad-groups/ad-group) and ads. Use the Ad Campaigns API to create campaigns, list campaigns for an account, retrieve or update campaign settings, and pause or resume campaign delivery. Ads billing combines eligible spend across the account's campaigns. A failed payment blocks delivery with `delivery_status: payment_failed` while preserving the configured active/paused `status`. Fix the account's payment method and [retry its ads payment](/api-reference/accounts/retry-failed-ads-payments) once for the account. The retry is asynchronous: acceptance does not confirm payment. Successful settlement clears the block; active campaigns can resume if otherwise eligible, while paused campaigns stay paused. See [billing and retries](/developer/ads/overview#paying-for-ads). name: Ad Campaigns x-whop-summary: Objective and budget for a set of ads. - description: > An Ad Group sits inside an [ad campaign](/api-reference/ad-campaigns/ad-campaign) and controls delivery for [ads](/api-reference/ads/ad). It sets the audience, schedule, and budget for its ads. Use the Ad Groups API to create ad groups in campaigns, list or retrieve targeting and delivery settings, update budgets or targeting, delete groups that should stop running, and pause or resume delivery. name: Ad Groups x-whop-summary: Audience, schedule, and budget within a campaign. - description: > An Ad is the individual creative unit delivered by an [ad group](/api-reference/ad-groups/ad-group). It holds the copy, creative assets, and destination URL for one ad. Use the Ads API to list ads for an account, create ads inside ad groups, retrieve or update creative details, delete ads that should stop running, and pause or resume delivery. name: Ads x-whop-summary: 'The creative: copy, assets, and destination URL.' - description: > An Audience is a reusable group of people to include or exclude when targeting ads. Build custom audiences from customer lists or Whop People data, and create lookalikes to reach people similar to an existing audience. Use the Audiences API to create audiences, add people to an uploaded customer list, rename or refilter an audience, and monitor asynchronous processing. Whop People audiences can refresh automatically or keep a snapshot. name: Audiences x-whop-summary: Reusable targeting lists for ad groups. - description: > An Ad Pixel connects a pixel you own on an ad platform to a business whose campaigns you claimed through the advertiser supplier program. Whop sends that pixel the conversions credited to your claimed campaigns for that business, using the access token you provide. Use the Ad Pixels API to add one pixel per business on each ad platform, list or retrieve your pixels, replace an access token the ad platform rejected, and remove a pixel to stop deliveries. name: Ad Pixels x-whop-summary: Your own pixels that receive conversions from campaigns you claimed. - description: > Stats represent aggregated activity for an account over time. They help you understand revenue, transactions, disputes, members, referrals, and advertising performance across reporting periods like days, weeks, or months. Use the Stats API to list the metrics you can chart and retrieve one as a time series over a date range, or list reports and retrieve aggregates that are not bucketed over time, such as platform-wide payment trends. name: Stats x-whop-summary: Aggregated financial, audience, and traffic reporting. - description: > A Person is an identity-linked profile of a visitor or customer of an account, assembled from every [event](/api-reference/events/event) the person generated, such as pixel page views, ad clicks, leads, and payments. Use the People API to list and segment the people of an account by activity, purchases, traffic source, or marketing touch, and to retrieve one person by person ID, user ID, email address, or phone number. name: People x-whop-summary: >- Visitors and customers of an account, with identity, purchase, and traffic profiles. - description: > An Event records conversion or engagement activity for an account, such as page views, purchases, or leads. Each event ties the action to the [person](/api-reference/people/person) who took it, so activity can be attributed to the ads and links that drove it. Use the Events API to send new tracking events, list recent identity-linked events for an account, and inspect the events recorded for a person. The resource also exposes an anonymized read mode — the pulse feed — a platform-wide snapshot of recent purchases that carries nothing identifying. The pulse feed is public; other Events endpoints require authentication and are scoped to an account. Events are only as good as the pixel sending them, so [Validate Pixel](/api-reference/events/validate-pixel) answers whether an account's pixel is working: it reads the events the pixel has sent, and when you pass a `url` whose page hasn't sent any lately, it fetches that page and looks for the pixel in its source. Use it before launching an ad to confirm its destination is tracked, or in a setup flow to tell a merchant whether their install is live. name: Events x-whop-summary: Conversion and engagement events tracked for attribution. - description: > An Export is a CSV of one of an account's dashboard tables, such as members, payments, or disputes. Exports are generated in the background, so a new export starts `pending` and becomes `completed` with a download link. Use the Exports API to start an export, poll it until `download_url` is set, and list an account's past exports. Each table requires its own export scope, and finished files are deleted after 30 days. name: Exports x-whop-summary: Asynchronous CSV dumps of an account's dashboard data. - description: > Economic Intelligence is Whop's recommendation engine for an account. Each recommendation is one action: a title the owner sees, a step-by-step brief Whop AI carries out, and the result it expects. Whop generates them from the account's sales, site, ads, and what its owner has said. Use the Economic Intelligence API to list an account's recommendations, request new ones for a specific goal, and follow each one from `queued` to `ready`, then to `executed` once the owner runs it or `superseded` when a newer one replaces it or you retire it. Read `economic_intelligence_offers` from account preferences and send one of its keys as `economic_intelligence_duration_key` to turn it on. name: Economic Intelligence x-whop-summary: What an account should do next to grow, generated from its own data. - description: > A Livestream represents a live video broadcast in an experience. After a recorded livestream ends, members can watch the replay, and moderators can pin the best recordings to feature them. Use the Livestreams API to [list an experience's livestreams](/api-reference/livestreams/list-livestreams), [retrieve one](/api-reference/livestreams/retrieve-livestream) with its recording, and [pin](/api-reference/livestreams/pin-livestream) or [unpin](/api-reference/livestreams/unpin-livestream) recordings. name: Livestreams x-whop-summary: Live video broadcasts in an experience, and their recordings. - description: > A Notification is a message delivered to a user, such as a new post, a payment, or a mention. Each one comes from an experience the user belongs to or a team they are on, and falls under a topic, like new sales, that users set preferences on. Use the Notifications API to list a user's feed, read and clear unread badges, send notifications from your app to an experience's users or an account's team, and list the topic catalog that notification preferences reference. name: Notifications x-whop-summary: >- The user's notification feed: unread badges, mark-read, app sends, and the topic catalog. - description: > An Email address is a mailbox on one of the account's domains, such as support@example.com. The domain needs the `email` capability in the `ready` state first. A mailbox either belongs to one team member, who alone can read it and send from it, or is shared by the account, where `email:read` and `email:send` decide who can use it. Use the Email addresses API to create, list, reassign and delete mailboxes, read the password mail apps sign in with, and download a configuration profile that adds the mailbox to Mail on Apple devices. Deleting an address keeps its mail, and creating it again in the same account brings the mailbox back. name: Email addresses x-whop-summary: Mailboxes on an account's domains, for sending and receiving email. - description: > Get started at [whop.com/network](https://whop.com/network). A Partner is a user who refers people and businesses to Whop. The partner profile includes enrollment, active direct business referral counts, and default payout terms. Retrieve your profile with `/partners/me`. Use `/partner_referral_requests` to create and manage referral links and their rewards. You can also enroll in the partner program, review referred users and businesses, track earnings, and see the partner leaderboard. name: Partners x-whop-summary: >- Your partner profile, referral links, payout rates, and referred businesses. - description: > A Partner Referral Request is a partner's referral link, or a request to be credited as the referrer of an existing business or user. An attribution request takes effect only when the recipient accepts it. Use the Partner Referral Requests API to create referral links, send attribution requests, list the links and requests you've sent or received, and accept, decline, or cancel a pending request. name: Partner Referral Requests x-whop-summary: Request business or partner attribution and manage approval. - description: > A Bounty is a paid task posted by an account or user. The reward is held in escrow when the bounty publishes, workers submit proof of completed work, and each accepted submission is paid out until every winner slot fills. Use the Bounties API to create and publish a bounty, list an account's bounties for reporting or dashboards, list the bounties a user can work or has participated in, and retrieve a single bounty by ID. name: Bounties x-whop-summary: Paid tasks with reviewed submissions and escrowed rewards. - description: > A Bounty Submission is one worker's attempt on a bounty. It starts as an in-progress attempt, enters the review queue when proof is submitted, and ends approved (paid from the bounty's escrowed pool) or denied. Use the Bounty Submissions API to submit proof of completed work to a bounty, list the submissions you authored, and review the submissions on your bounties — across every bounty or narrowed to one. name: Bounty Submissions x-whop-summary: Work submitted to a bounty, from attempt to payout. - description: > A File is an uploaded document or media object, identified by a `file_` ID. Creating a file returns a presigned destination; upload the bytes there and the file becomes `ready`. Use the Files API to create a file, upload its content directly to storage (in one PUT, or in parts for large files), and retrieve it while polling for readiness. A ready file's ID can be attached wherever Whop accepts files. name: Files x-whop-summary: Upload files and attach them wherever Whop accepts documents. - description: > A Media Asset is an AI-generated image or video created from a prompt and billed from an account balance. When generation finishes, the asset includes a file that can be attached anywhere Whop accepts files. Use the Media API to start a generation job and retrieve the asset while it processes or after it is ready. name: Media x-whop-summary: >- AI-generated assets, billed from a balance, attachable wherever files are accepted. - description: > An API Key is a programmatic credential owned by an account or app. Each key carries its own permissions policy — explicit permission statements or an inherited system role — and can be restricted with an expiration date and an IP allowlist. Use the API Keys API to list an account or app's keys, create a key (the full secret is returned once, on creation), inspect a key's effective grants, update its name or restrictions, rotate its secret, and revoke it. These endpoints require a user session — they cannot be called with an API key. name: API Keys x-whop-summary: Programmatic credentials for an account or app. - description: > A Webhook is an endpoint on your server that Whop sends signed HTTP POST requests to when events happen, such as a payment succeeding or a membership going active. A webhook is attached to an account or an app and subscribes to the events you choose. Use the Webhooks API to create and update endpoints, send a test event, inspect the delivery log, and replay deliveries your server missed. See [Webhooks & Events](/developer/guides/webhooks) for verifying signatures and handling retries. name: Webhooks x-whop-summary: Event notifications pushed to your server as things happen. - description: > A Permission is one action, such as `stats:read`, paired with whether your credential is granted it on a given resource. It answers for whatever you authenticated with, so you can decide what to show or attempt instead of discovering a `403`. Use the Permissions API to check an account, product, experience, or app, narrowing to the actions you care about. It reports only your own access — to manage who else can reach an account, use the Team Members API. name: Permissions x-whop-summary: What your credential is allowed to do on a resource. - description: > An Api Log is a record of a single request made to Whop's API using one of your account's API keys — the programmatic counterpart to the dashboard audit log, which only records actions taken by signed-in team members. Reads and failed requests are logged too. Use the Api Logs API to see what your integrations are doing on Whop: the operation, HTTP method and status, outcome, and timing of each request, newest first. name: Api Logs x-whop-summary: Requests made to Whop's API with your account's API keys. - description: > A feedback submission sends an issue, confusing behavior, documentation gap, or unanswered question to Whop. It is recorded under the authenticated user, account, or app, with an optional account for context, and reviewed by Whop. User, account, and app credentials can all submit. The response is a receipt with an `fbk_` ID: Whop does not reply to submissions, and they cannot be listed or retrieved through the API. name: Feedback x-whop-summary: Issues and unanswered questions sent to Whop for review. paths: /stats/time_series/{metric}: parameters: - description: >- The metric to retrieve, for example net_revenue. Use GET /stats/time_series to see every metric key. The metric sets the unit and the properties you can filter or break down by. in: path name: metric required: true schema: type: string - $ref: '#/components/parameters/ApiVersionDate' get: tags: - Stats summary: Retrieve Metric Time Series description: >- Retrieves a metric as a series of points over a time range for an account or user. For an aggregate that is not bucketed over time, use a report from `GET /stats/reports`. The `market_prices` metric is public and requires no authentication. operationId: retrieveMetricTimeSeries parameters: - description: >- Account this query concerns, prefixed `biz_`, or `platform` for all of Whop. in: query name: account_id required: false schema: type: string - description: >- The user this query concerns, for example user_AbC123. Available on metrics that support user subjects, such as account_balance. in: query name: user_id required: false schema: type: string - description: >- Start of the range — a date (YYYY-MM-DD), expanded to the start of that day, or an ISO 8601 timestamp (for example 2026-07-16T16:37:00Z), used exactly. in: query name: from required: true schema: type: string - description: >- End of the range — a date (YYYY-MM-DD), expanded to the end of that day, or an ISO 8601 timestamp (for example 2026-07-17T16:37:00Z), used exactly. Funnel entry ranges cannot exceed 90 days. in: query name: to required: true schema: type: string - description: >- How wide each point is. Defaults to day. Snapshot metrics are day-only. Funnels support at most 2,000 first-entry cohort buckets. in: query name: interval required: false schema: enum: - minute - five_minutes - thirty_minutes - hour - day - week - month - year type: string - description: >- Split the metric out by one of its properties — each point gets a breakdown array. For example breakdown_by=currency returns an entry for usd, an entry for eur, and so on. Funnels use a property of the first matched event, with at most 300 groups. experiment_id and variant require an exposure as step 1. For funnel source breakdowns, steps[1][source]=whop:* groups by campaign, whop::* by ad group, and whop:::* by ad. See the metric catalog for supported breakdowns. in: query name: breakdown_by required: false schema: type: string - description: >- Display currency for money metrics — every amount is converted into this ISO currency using the exchange rate on each period's date. Defaults to usd. For the ads metrics (ad_spend, ad_delivery), pass the account's ads reporting currency to match the ad entity endpoints. On transaction metrics, it is ignored when you filter or break down by currency (those report the original transaction currency, unconverted). in: query name: convert_to required: false schema: type: string - description: >- Select the source currency or asset on metrics that list currency. For transaction metrics, for example currency=eur, values are reported without conversion. For market_prices, use btc or xaut and convert_to=usd. Pair with breakdown_by=currency to split a metric by currency. in: query name: currency required: false schema: type: string - description: >- IANA time zone to bucket the series in, for example America/New_York. Defaults to UTC. Not accepted by snapshot metrics, which are UTC only. in: query name: time_zone required: false schema: type: string - description: >- Filter to a single payment method, for example card or crypto. Available on metrics that list payment_method. in: query name: payment_method required: false schema: type: string - description: >- Filter to a single card brand, for example visa. A refinement of payment_method=card. Available on metrics that list card_network. in: query name: card_network required: false schema: type: string - description: >- Filter disputes to a normalized reason, for example product_not_received. Pair with breakdown_by=dispute_reason to split dispute counts by reason. in: query name: dispute_reason required: false schema: type: string - description: >- Filter to a single GMV source, for example payments — or, on the traffic metrics, a visit source (whop_ads, direct, or a utm_source value). Pair with breakdown_by=source to split by source. Available on metrics that list source. in: query name: source required: false schema: type: string - description: >- Filter traffic metrics to one website hostname, for example shop.example.com. On the events and people metrics, comma-separated hostnames match any listed hostname. Pair with breakdown_by=hostname to split by website. in: query name: hostname required: false schema: type: string - description: >- Filter traffic metrics to one page — a hostname plus normalized path, for example shop.example.com/pricing. Pair with breakdown_by=page to split by page. in: query name: page required: false schema: type: string - description: >- Filter traffic metrics to one device type: desktop, mobile, tablet, or unknown. Pair with breakdown_by=device_type to split by device. in: query name: device_type required: false schema: type: string - description: >- Filter traffic metrics to one visitor country (uppercase ISO 3166-1 alpha-2, for example US). Pair with breakdown_by=country_code to split by country. in: query name: country_code required: false schema: type: string - description: >- Filter the events metric to one tracked event name, for example pixel.page or pixel.custom. Pair with breakdown_by=event_name to split by event. in: query name: event_name required: false schema: type: string - description: >- Filter the events metric to a canonical group of events: page_view (pixel page views plus whop.com store views), checkout_start (hosted and embedded checkout views), or other. Pair with breakdown_by=event_type to split by group. in: query name: event_type required: false schema: enum: - page_view - checkout_start - other type: string - description: >- Filter the events metric to one merchant-defined custom event name. Only valid alongside event_name=pixel.custom. Pair with breakdown_by=custom_name to split custom events by name. in: query name: custom_name required: false schema: type: string - description: >- Filter to a single wallet-balance segment, for example available. Pair with breakdown_by=segment to split the balance. Available on metrics that list segment. in: query name: segment required: false schema: type: string - description: >- Filter to a single balance-activity category, for example payments. Pair with breakdown_by=category to split the activity. Available on metrics that list category. in: query name: category required: false schema: type: string - description: >- Filter to a single cashback merchant bucket, for example whop-ads. Pair with breakdown_by=merchant to split cashback by merchant. Available on metrics that list merchant. in: query name: merchant required: false schema: type: string - description: >- Filter to a single fee type. Pair with breakdown_by=fee_type to split fees by type. Available on metrics that list fee_type. in: query name: fee_type required: false schema: type: string - description: >- Filter to a single product (access pass id), for example prod_AbC123. Pair with breakdown_by=product. Available on metrics that list product. in: query name: product required: false schema: type: string - description: >- Filter to a single membership status. Pair with breakdown_by=status. Available on metrics that list status. in: query name: status required: false schema: type: string - description: >- Filter to a single access level. Pair with breakdown_by=access_level. Available on metrics that list access_level. in: query name: access_level required: false schema: type: string - description: >- Filter to a single most-recent member action. Pair with breakdown_by=most_recent_action. Available on metrics that list most_recent_action. in: query name: most_recent_action required: false schema: type: string - description: >- Filter a referral metric to the businesses attributed to one person you referred, for example user_AbC123. Available on metrics that list referred_user_id. in: query name: referred_user_id required: false schema: type: string - description: >- Ad campaign ids (adcamp_...) to scope the report to; stats are summed across them. Available on metrics that list ad_campaign_ids. in: query name: ad_campaign_ids required: false schema: items: example: adcamp_xxxxxxxxxxxxxx type: string type: array - description: >- Ad group ids (adgrp_...) to scope the report to; stats are summed across them. Available on metrics that list ad_group_ids. in: query name: ad_group_ids required: false schema: items: example: adgrp_xxxxxxxxxxxxxx type: string type: array - description: >- Ad ids (ad_...) to scope the report to; stats are summed across them. Available on metrics that list ad_ids. in: query name: ad_ids required: false schema: items: example: ad_xxxxxxxxxxxxxx type: string type: array - description: >- Window used by a snapshot metric. Ordinary snapshots accept 30d as their trailing activity window. Cohorted dispute metrics accept 7d or 28d as the sales-transaction pool; their attribution window is fixed in the metric name. Card network program metrics accept 7d, 14d, 28d, or 56d. Each metric lists its accepted values in the catalog. in: query name: snapshot_window required: false schema: enum: - 7d - 14d - 28d - 30d - 56d type: string - description: >- Filter the events metric to one or more full event names, for example payment.completed or pixel.lead. Comma-separated names match any listed event. Use group_by=event for separate groups. Available on metrics that list event. in: query name: event required: false schema: type: string - description: >- Filter to one business type, for example `education`. Pair with `breakdown_by=business_type` to split by business type. Available on metrics that list `business_type`. in: query name: business_type required: false schema: type: string - description: >- Filter to one industry type, for example `options_trading`. Pair with `breakdown_by=industry_type` to split by industry type. Available on metrics that list `industry_type`. in: query name: industry_type required: false schema: type: string - description: >- Filter to one product category, for example `algo_trading_course`. Pair with `breakdown_by=product_category` to split by product category. Available on metrics that list `product_category`. in: query name: product_category required: false schema: type: string - description: >- Filter to accounts located in one country, as an ISO 3166-1 alpha-2 code such as `US`. Pair with `breakdown_by=account_country` to split by account country. Available on metrics that list `account_country`. in: query name: account_country required: false schema: type: string - description: >- Filter to one card-issuing bank, named as the processor reports it, for example JPMORGAN CHASE BANK N A, or unknown for payments with no reported bank. Available on metrics that list issuer. in: query name: issuer required: false schema: type: string - description: >- Funnel only. Time allowed from the first event to the final event: integer minutes, hours, or days, up to 30d. in: query name: conversion_window required: false schema: default: 7d pattern: ^[1-9][0-9]*[mhd]$ type: string - description: >- Funnel only. Include only entrants whose full conversion window has elapsed. Required for confidence intervals and comparisons. in: query name: mature_only required: false schema: default: false type: boolean - description: >- Funnel only. Required when metric=funnel. 2 to 10 ordered events per person, as consecutive one-based bracket parameters such as `steps[1][event]=pixel.page&steps[1][page]=/pricing*&steps[2][event]=payment.completed`. Values are scalar strings, never JSON. A person's first step 1 match inside `from`/`to` anchors their cohort, breakdown, and conversion window; later matches do not restart it. Other events may occur between steps, and conversions may land after `to`. For an experiment funnel, make `experiment.exposure` step 1 and pass `breakdown_by=variant`. explode: true in: query name: steps required: false schema: additionalProperties: false properties: '1': $ref: '#/components/schemas/FunnelStep' '2': $ref: '#/components/schemas/FunnelStep' '3': $ref: '#/components/schemas/FunnelStep' '4': $ref: '#/components/schemas/FunnelStep' '5': $ref: '#/components/schemas/FunnelStep' '6': $ref: '#/components/schemas/FunnelStep' '7': $ref: '#/components/schemas/FunnelStep' '8': $ref: '#/components/schemas/FunnelStep' '9': $ref: '#/components/schemas/FunnelStep' '10': $ref: '#/components/schemas/FunnelStep' required: - '1' - '2' type: object style: deepObject - description: >- Funnel only. The breakdown value to use as baseline for whole-window final conversion. Requires breakdown_by and mature_only=true; defaults confidence_level to 0.95. in: query name: compare_to required: false schema: type: string - description: >- Funnel only. Confidence level for whole-window final conversion intervals, for example 0.95. Requires mature_only=true. Exposure steps must each filter one user-randomized experiment. in: query name: confidence_level required: false schema: exclusiveMaximum: 1 exclusiveMinimum: 0 type: number - description: >- People metric only: contactable equals this value. Applies to the current person profile for every time bucket. LTV and AOV are in USD. Not accepted by the Events metric. in: query name: contactable required: false schema: type: boolean - description: >- People metric only: has_purchased equals this value. Applies to the current person profile for every time bucket. LTV and AOV are in USD. Not accepted by the Events metric. in: query name: has_purchased required: false schema: type: boolean - description: >- People metric only: first_seen_at greater than or equal this value. Applies to the current person profile for every time bucket. LTV and AOV are in USD. Not accepted by the Events metric. in: query name: first_seen_after required: false schema: format: date-time type: string - description: >- People metric only: first_seen_at less than this value. Applies to the current person profile for every time bucket. LTV and AOV are in USD. Not accepted by the Events metric. in: query name: first_seen_before required: false schema: format: date-time type: string - description: >- People metric only: last_seen_at greater than or equal this value. Applies to the current person profile for every time bucket. LTV and AOV are in USD. Not accepted by the Events metric. in: query name: last_seen_after required: false schema: format: date-time type: string - description: >- People metric only: last_seen_at less than this value. Applies to the current person profile for every time bucket. LTV and AOV are in USD. Not accepted by the Events metric. in: query name: last_seen_before required: false schema: format: date-time type: string - description: >- People metric only: first_seen_at within this many days of now. Applies to the current person profile for every time bucket. LTV and AOV are in USD. Not accepted by the Events metric. in: query name: first_seen_within_days required: false schema: minimum: 0 type: integer - description: >- People metric only: last_seen_at within this many days of now. Applies to the current person profile for every time bucket. LTV and AOV are in USD. Not accepted by the Events metric. in: query name: last_seen_within_days required: false schema: minimum: 0 type: integer - description: >- People metric only: known equals this value. Applies to the current person profile for every time bucket. LTV and AOV are in USD. Not accepted by the Events metric. in: query name: known required: false schema: type: boolean - description: >- People metric only: has_email equals this value. Applies to the current person profile for every time bucket. LTV and AOV are in USD. Not accepted by the Events metric. in: query name: has_email required: false schema: type: boolean - description: >- People metric only: has_phone equals this value. Applies to the current person profile for every time bucket. LTV and AOV are in USD. Not accepted by the Events metric. in: query name: has_phone required: false schema: type: boolean - description: >- People metric only: ltv greater than this value. Applies to the current person profile for every time bucket. LTV and AOV are in USD. Not accepted by the Events metric. in: query name: ltv_gt required: false schema: type: number - description: >- People metric only: ltv greater than or equal this value. Applies to the current person profile for every time bucket. LTV and AOV are in USD. Not accepted by the Events metric. in: query name: ltv_gte required: false schema: type: number - description: >- People metric only: ltv less than this value. Applies to the current person profile for every time bucket. LTV and AOV are in USD. Not accepted by the Events metric. in: query name: ltv_lt required: false schema: type: number - description: >- People metric only: ltv less than or equal this value. Applies to the current person profile for every time bucket. LTV and AOV are in USD. Not accepted by the Events metric. in: query name: ltv_lte required: false schema: type: number - description: >- People metric only: aov greater than this value. Applies to the current person profile for every time bucket. LTV and AOV are in USD. Not accepted by the Events metric. in: query name: aov_gt required: false schema: type: number - description: >- People metric only: aov greater than or equal this value. Applies to the current person profile for every time bucket. LTV and AOV are in USD. Not accepted by the Events metric. in: query name: aov_gte required: false schema: type: number - description: >- People metric only: aov less than this value. Applies to the current person profile for every time bucket. LTV and AOV are in USD. Not accepted by the Events metric. in: query name: aov_lt required: false schema: type: number - description: >- People metric only: aov less than or equal this value. Applies to the current person profile for every time bucket. LTV and AOV are in USD. Not accepted by the Events metric. in: query name: aov_lte required: false schema: type: number - description: >- People metric only: purchase_count greater than this value. Applies to the current person profile for every time bucket. LTV and AOV are in USD. Not accepted by the Events metric. in: query name: purchase_count_gt required: false schema: type: number - description: >- People metric only: purchase_count greater than or equal this value. Applies to the current person profile for every time bucket. LTV and AOV are in USD. Not accepted by the Events metric. in: query name: purchase_count_gte required: false schema: type: number - description: >- People metric only: purchase_count less than this value. Applies to the current person profile for every time bucket. LTV and AOV are in USD. Not accepted by the Events metric. in: query name: purchase_count_lt required: false schema: type: number - description: >- People metric only: purchase_count less than or equal this value. Applies to the current person profile for every time bucket. LTV and AOV are in USD. Not accepted by the Events metric. in: query name: purchase_count_lte required: false schema: type: number - description: >- People metric only: event_count greater than this value. Applies to the current person profile for every time bucket. LTV and AOV are in USD. Not accepted by the Events metric. in: query name: event_count_gt required: false schema: type: number - description: >- People metric only: event_count greater than or equal this value. Applies to the current person profile for every time bucket. LTV and AOV are in USD. Not accepted by the Events metric. in: query name: event_count_gte required: false schema: type: number - description: >- People metric only: event_count less than this value. Applies to the current person profile for every time bucket. LTV and AOV are in USD. Not accepted by the Events metric. in: query name: event_count_lt required: false schema: type: number - description: >- People metric only: event_count less than or equal this value. Applies to the current person profile for every time bucket. LTV and AOV are in USD. Not accepted by the Events metric. in: query name: event_count_lte required: false schema: type: number - description: >- Read a referral metric for a business instead of the caller: the referrals its team members made, past members included, for example biz_AbC123. Requires company:basic:read on that business and cannot be combined with user_id. Available on metrics that list referring_account_id. in: query name: referring_account_id required: false schema: type: string - description: >- Read a partner metric for one team lead and everyone under them in today's org chart, for example user_AbC123. Needs referring_account_id or a global query. As breakdown_by=team_lead_id, figures sit under the highest lead above the partner who earned them, so each group matches that lead's team_lead_id filter and the groups add up to the total. With team_lead_id set, or for a caller who reads only their own team, the groups are the leads under that person, who keeps the rest. Anyone with no lead is in a null group. Available on metrics that list team_lead_id. in: query name: team_lead_id required: false schema: type: string - description: >- partner_reps only: all counts the period's roster, earning counts those who earned in the period, and not_earning counts the roster minus them. Defaults to all. in: query name: activity required: false schema: enum: - all - earning - not_earning type: string - description: >- With a single breakdown_by, keep the groups with the highest whole-range values, up to this many, and fold every other group into one entry named other. A rate or an average ranks its groups by the deals it divides by. The other entry is measured from the underlying rows, so a distinct count or a rate stays exact rather than being added up from groups. Available on partner metrics only. in: query name: breakdown_limit required: false schema: maximum: 50 minimum: 1 type: integer responses: '200': content: application/json: schema: properties: data: properties: currency: description: >- ISO currency the values are denominated in. Present for currency-unit metrics: the convert_to currency, or usd. example: usd nullable: true type: string points: description: One entry per period, oldest first. items: properties: breakdown: description: >- Present only when broken down: one entry per property value in this period. items: properties: name: description: >- The property value, for example usd or visa. example: spend type: string steps: description: >- Present for the funnel metric. People reaching each step in order, starting with the entry step. items: $ref: '#/components/schemas/FunnelStepResult' type: array value: description: The metric's value for this entry. example: 2.82 nullable: true type: number required: - name - value type: object type: array steps: description: >- Present for the funnel metric. People reaching each step in order, starting with the entry step. items: $ref: '#/components/schemas/FunnelStepResult' type: array timestamp: description: Unix timestamp (seconds) of the period start. example: 1767268800 type: integer value: description: >- The metric's value for this period, in the metric's unit. For `funnel`, the final-step conversion percentage. example: 3 nullable: true type: number required: - timestamp - value type: object type: array totals: description: >- Whole-window aggregates, present when the metric computes them. Don't derive these from `points`: a rate is measured across the whole window, not averaged across its points, and whole-window unique people are distinct across every bucket. items: properties: comparison: $ref: '#/components/schemas/FunnelComparison' confidence_interval: $ref: '#/components/schemas/FunnelConfidenceInterval' description: >- Funnel only. The Wilson interval for final conversion, present when confidence_level or compare_to is supplied. name: description: >- The property value this total is for, or the metric's name when it isn't split by a property. example: wins type: string steps: description: >- Present for the funnel metric. People reaching each step in order, starting with the entry step. items: $ref: '#/components/schemas/FunnelStepResult' type: array value: description: The metric's whole-window value for this entry. example: 4 nullable: true type: number required: - name - value type: object nullable: true type: array required: - points type: object required: - data type: object description: a user-scoped metric via a scoped OAuth token '400': $ref: '#/components/responses/InvalidParameters' description: subject tag type mismatch '401': $ref: '#/components/responses/Unauthorized' description: missing or invalid authentication for an account-scoped metric '403': $ref: '#/components/responses/Forbidden' description: a user-scoped metric with a credential that cannot act as a user '404': $ref: '#/components/responses/NotFound' description: unknown account security: - bearerAuth: - stats:read - bearerAuth: - ad_campaign:read components: parameters: ApiVersionDate: description: Pins the request to a dated API version. in: header name: Api-Version-Date required: false schema: example: 2026-11-04-1 type: string schemas: FunnelStep: additionalProperties: false properties: app_build_id: description: >- The Whop app build ID attached to the event. Comma-separated alternatives are ORed; different filters are ANDed. maxLength: 1024 type: string app_id: description: >- The event's app id. Comma-separated alternatives are ORed; different filters are ANDed. maxLength: 1024 type: string browser: description: >- The event's browser. Comma-separated alternatives are ORed; different filters are ANDed. maxLength: 1024 type: string city: description: >- The event's city. Comma-separated alternatives are ORed; different filters are ANDed. maxLength: 1024 type: string country: description: >- The event's country. Comma-separated alternatives are ORed; different filters are ANDed. maxLength: 1024 type: string custom_name: description: >- The custom event name. Requires event=pixel.custom. Comma-separated alternatives are ORed; different filters are ANDed. maxLength: 1024 type: string device: description: >- The event's device. Comma-separated alternatives are ORed; different filters are ANDed. maxLength: 1024 type: string event: description: >- The event name, such as pixel.page, pixel.custom, experiment.exposure, or payment.completed. Exactly one event per step. maxLength: 1024 type: string experiment_id: description: >- An experiment ID owned by account_id. Requires event=experiment.exposure. Comma-separated alternatives are ORed; different filters are ANDed. maxLength: 1024 type: string hostname: description: >- The event's hostname. Comma-separated alternatives are ORed; different filters are ANDed. maxLength: 1024 type: string os: description: >- The event's os. Comma-separated alternatives are ORed; different filters are ANDed. maxLength: 1024 type: string page: description: >- The URL pathname. Use * to match zero or more characters, including slashes. Other characters match literally. Missing pages do not match. Comma-separated alternatives are ORed; different filters are ANDed. maxLength: 1024 type: string plan_id: description: >- The plan ID attached to the event. Comma-separated alternatives are ORed; different filters are ANDed. maxLength: 1024 type: string product_id: description: >- The product ID attached to the event. Comma-separated alternatives are ORed; different filters are ANDed. maxLength: 1024 type: string source: description: >- The Whop ad-click source of this page view, not conversion attribution. Use whop:* for any Whop ad click, whop::* for a campaign, or whop::: for an exact ad. Only ad-click page-view events support source. With breakdown_by=source, trailing :* levels select campaign, ad-group, or ad detail. Comma-separated alternatives are ORed; different filters are ANDed. maxLength: 1024 type: string utm_source: description: >- The event's utm source. Comma-separated alternatives are ORed; different filters are ANDed. maxLength: 1024 type: string variant: description: >- The exposed variant name. Requires event=experiment.exposure. Comma-separated alternatives are ORed; different filters are ANDed. maxLength: 1024 type: string required: - event type: object FunnelStepResult: properties: conversion_rate: description: >- The percentage of first-step entrants reaching this step; null when there are no entrants. example: 100 nullable: true type: number count: description: The number of distinct people reaching this step. example: 100 type: integer step: description: The one-based step number. example: 1 type: integer required: - step - count - conversion_rate type: object FunnelComparison: anyOf: - properties: baseline: description: The reference group's name. type: string difference_confidence_interval: $ref: '#/components/schemas/FunnelConfidenceInterval' description: >- Adjusted Wald interval for the difference in percentage points, with Bonferroni correction across comparisons. difference_percentage_points: description: This group's conversion percentage minus the baseline's. type: number relative_lift_percent: description: >- Relative conversion improvement in percent; null if baseline conversion is zero. nullable: true type: number required: - baseline - difference_percentage_points - relative_lift_percent - difference_confidence_interval type: object - type: 'null' description: >- Funnel only. Present when compare_to is supplied; null on the baseline itself. Comparisons are descriptive and do not establish causation. FunnelConfidenceInterval: anyOf: - properties: lower: description: >- The lower confidence bound, in percent or percentage points for a difference. type: number upper: description: >- The upper confidence bound, in percent or percentage points for a difference. type: number required: - lower - upper type: object - type: 'null' V1ErrorResponse: properties: error: properties: code: description: >- Machine-readable reason for this specific refusal, such as `bank_warning_not_acknowledged`. Only present when the error carries one. type: string message: description: Human-readable error message. example: account_id is required type: string type: description: Machine-readable error code. example: bad_request type: string required: - type - message type: object required: - error type: object responses: InvalidParameters: content: application/json: schema: $ref: '#/components/schemas/V1ErrorResponse' description: Invalid Parameters Unauthorized: content: application/json: schema: $ref: '#/components/schemas/V1ErrorResponse' description: Unauthorized Forbidden: content: application/json: schema: $ref: '#/components/schemas/V1ErrorResponse' description: Forbidden NotFound: content: application/json: schema: $ref: '#/components/schemas/V1ErrorResponse' description: Resource not found securitySchemes: bearerAuth: bearerFormat: auth-scheme description: >- An Account API key, an App API key, an account access token, an account-scoped user token, or a user OAuth token. Prepend the key or token with `Bearer`, for example `Bearer ***************************`. See [Auth & API keys](/developer/guides/auth-scoping) for how to get each one. scheme: bearer type: http ```` ## Related topics - [Stats](https://docs.whop.com/api-reference/stats/stats.md) - [Stats API](https://docs.whop.com/developer/guides/stats.md) - [List Time Series Metrics](https://docs.whop.com/api-reference/stats/list-time-series-metrics.md)