> ## 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. # Retrieve Metric Time Series > Retrieves a metric as a time series of points for an account or user over a time range. 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. The `funnel` metric measures 2 to 10 ordered events per person. Its first matching event inside from/to anchors the cohort, breakdown and conversion window; later entries do not restart it. Intervening events are allowed, and conversions may occur after to. Funnel values are final conversion percentages; steps include counts and cumulative conversion percentages. Experiment funnels use experiment.exposure as step 1 and breakdown_by=variant. Pass steps using bracket parameters such as steps[1][event]=pixel.page&steps[1][page]=/pricing*&steps[2][event]=payment.completed. ## 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-10-06-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 connected account 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 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: > A Member is one buyer's relationship with an account — one record per customer regardless of how many memberships they hold. It carries relationship-level state: whether they have joined or left, their access level (`customer`, `admin`, or `no_access`), when they joined, and when they last opened the account's content. Use the Members API to list an account's members with filtering by access level, status, join date, and name or username search, and to retrieve a single member. 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: > Economic Intelligence is Whop's recommendation engine for an account. Each recommendation is a single action: a title the owner sees, a step-by-step brief Whop AI carries out, and the bet it makes on the account's ledger. Whop generates them from the account's sales, site, ads, and what its owner has said. Use the Economic Intelligence API to list recommendations and to request actions for a specific goal with POST. For callers with company:update permission, listing automatically queues generation when no actions are ready or in progress, with a ten-minute cooldown after an unsuccessful request from the current pipeline version. A new request returns a recommendation with status `queued`; the engine moves it through `pending` to `ready`. Unsuccessful requests are omitted from the list. A `ready` recommendation becomes `executed` once the owner runs it from the dashboard, or `superseded` when a newer one replaces it. name: Economic Intelligence x-whop-summary: What an account should do next to grow, generated from its own data. - name: Webhooks x-whop-summary: Event notifications pushed to your server as things happen. - 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 available metrics and their filterable properties, then retrieve time-series values for a date range. name: Stats x-whop-summary: Aggregated financial, audience, and traffic reporting. - 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/beta/verifications/update-verification). name: Verifications x-whop-summary: Legal identity required before payouts and card issuing. - description: > A financing application requests review of a merchant account for payment financing. It is not an application for a loan or business capital. Create, list, and retrieve applications for your account and its direct sub-accounts. Creating an application returns an existing open application when one is already collecting information or awaiting review. name: Financing Applications x-whop-summary: Merchant applications to accept financing payments. - description: > An Export is an asynchronous CSV of one resource for one account — members, payments, disputes, ads, and the other tables the Whop dashboard can export. Generating a full table takes longer than a request, so an export is created in `pending`, moves through `processing`, and lands on `completed` with a download link. Each resource requires that resource's own export scope. Use the Exports API to start an export, poll it until `download_url` is set, and list the exports already requested for an account. Finished CSVs are retained for 30 days, after which the file is deleted and the export moves to `expired`. name: Exports x-whop-summary: Asynchronous CSV dumps of an account's dashboard data. - description: > A Notification is a message delivered to a user — a new post, a payment, a mention. Every notification comes from an experience the user belongs to or a team they are on, and users control what they receive with notification preferences. Every notification belongs to a topic: the category it falls under, such as new sales or account activity. Topics carry a default, so a user only needs a preference row where they diverge from it. `GET /notifications/topics` lists the platform's visible topics, and a topic's `id` is what the notification preference endpoints take as `topic_id` — the catalog is the only place those ids come from, so read it rather than hardcoding. Each topic also carries an `identifier` such as `new-follower`, which is stable across environments and is the value to match on in code. Use the Notifications API to list the authenticated user's feed, read per-experience unread badges, mark an experience (or everything) as read, send notifications from your app to an experience's users or an account's team, and list the topic catalog. name: Notifications x-whop-summary: >- The user's notification feed: unread badges, mark-read, app sends, and the topic catalog. - description: > A Payment is one charge against a buyer. 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. Collection runs in the background, so the create response is not the outcome. Poll [Retrieve status](/api-reference/beta/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. Use the return_url operation 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: > A Payment Quote prices a purchase exactly as a payment for it will be charged: the same line pricing, the same promo code, the same per-line tax calculation. The body is the `PaymentInput` a payment takes (the account, the variants or an inline plan, the promo code) plus where the buyer is: `address`, `shipping_address`, `tax_ids` and `ip_address`. Tax is calculated for the shipping address, else the billing address, else the IP address, and `located_by` says which one priced it. A seller who collects no tax on the purchase needs no location at all. Pass the quote's `id` as `quote_id` when you create the payment and the buyer is charged exactly this quote: its purchase (which the payment may then omit), its promo code and its `tax_amount`, with no figure recomputed at charge time. A quote is priced once, may be consumed by one payment, and expires at `expires_at`; quote again whenever the cart, the promo code or the address changes. It is priced in the variants' own currency unless you send `presentment_currency` (`auto` for the currency of the country Whop places the buyer's `ip_address` in, or a currency code): every amount is then converted at an `exchange_rate` fixed until `expires_at`, the payment is charged in that currency at that rate, and `recommended_currencies` lists the currencies to offer the buyer. A quote located by `ip_address` is a preview: show it, then quote again with the buyer's address to pay. `tax_status` says whether every line was priced (`calculated`), whether the seller collects no tax on this purchase (`not_applicable`), or whether tax could not be priced (`unavailable`, which a payment refuses: quote again, or charge without `quote_id` to have tax calculated at charge time). name: Payment Quotes x-whop-summary: 'A purchase priced before it is paid: its lines, promo code and tax.' - description: > A Refund is one reversal of a payment, full or partial. Refunds are issued with `POST /payments/{id}/refund`; this resource is the record of each one — how much moved, through which provider, and where it stands (`pending`, `succeeded`, `failed`). List a payment's refunds with `?payment_id=`, or every refund an account issued with `?account_id=`. `amount` is stated in the payment's settlement currency so it nets against the payment's `total`; `original_amount` is what the processor moved. name: Refunds x-whop-summary: Money returned to a buyer from a payment. - 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. Public callers receive a billing preview; bearer-authenticated callers with `payment:basic:read` on the token’s account also receive the collected billing address. 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 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/beta/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 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/beta/payment-rules/replace-a-payment-rule) to change one, and [List fields](/api-reference/beta/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: > 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. name: Disputes x-whop-summary: Chargebacks filed against an account, with evidence and outcomes. - 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 Resolution Center Case is opened by a buyer when something is wrong with a purchase — an unwanted renewal, an item that never arrived, or a charge they don't recognize. It is the step before a chargeback: the two sides work it out directly, and Whop decides the case if they can't. Each case carries a reason, a status naming which side it is waiting on, a timeline of events, and the actions available to whoever is reading it. Use the Resolution Center Cases API from either side: as the buyer, open a case, reply, appeal a decision, or withdraw it; as the merchant, accept it (refunding the payment), deny it, or ask the buyer for more information. Both sides read the same case, page its timeline, and summarize the cases they can see. name: Resolution Center Cases x-whop-summary: File or respond to a case against a payment, as the buyer or the merchant. - description: > A Ledger Activity row is a single financial event on an account's ledger — a payment, payout, refund, transfer, on-chain deposit, swap, or card transaction. Each row is derived from the underlying ledger lines and carries a typed `resource` and `source` so you can present and link the event without extra lookups. Use Ledger Activity to build a statement or transaction feed for an account or user. Reconcile against your own records with `amount` (signed, in the currency's smallest precision units) and `posted_at`, and use `available_at` to group credits and debits by when they affect available funds. Pending activity uses its scheduled release date; activity posted to available funds uses its posted time, including refunds, disputes and payouts. Default activity excludes some movements, including opt-in reserves. name: Ledgers x-whop-docs-title: Financial Activity x-whop-summary: The activity feed behind an account or user's balance. - 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: > 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, and retrieve active card details such as the card number and CVC. name: Cards x-whop-summary: Issue cards that spend from a balance. - description: > Cashback rules designate a funding platform, optional merchant name and category filters, a rate, and an eligibility window. Every supplied merchant filter must match. An account ID limits the rule to one of the platform's direct connected accounts and is required when both merchant filters are omitted or null. Use the Cashback Rules API to create future-dated rules, update their merchant name, MCC, description, or expiration, and list every rule funded by the authenticated platform, including expired and discarded rules. Discarded rules cannot be updated. Creating or updating a rule does not transfer funds. Pay out cashback on demand from the platform's available USD balance with optional rule, account, and transaction filters. Only completed, unpaid, eligible transactions are paid. The response returns status `processing` and echoes supplied filters; `failed` means the queue rejected the request. These statuses describe scheduling, not payment completion. name: Cashback Rules x-whop-summary: Configure platform-sponsored card cashback. - description: > Transfers move value between identities on Whop. They are used for account-to-account money movement, user payouts inside Whop, crypto transfers, and claim links depending on the destination type. Use the Transfers API to create a transfer, list previous transfers, and retrieve a transfer by ID when reconciling money movement between accounts or users. 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: > Deposits describe ways to add funds to an account balance, including hosted deposit pages, bank deposit instructions, and supported crypto wallet addresses. Use the Deposits API to create deposit instructions for an account. Crypto deposits require a $10 minimum. name: Deposits x-whop-summary: Add funds to a balance. - description: > Swaps convert value between supported tokens, chains, or wallet destinations for an account. A swap quote describes 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 status until the transaction completes. name: Swaps x-whop-summary: Convert a balance between currencies. - description: > A Trade records an order batch, cancellation, or leverage change submitted to a trading provider from an account or user's Whop-managed wallet. Its `status` tracks the submission, not whether orders filled. Use the Trades API to place limit or market orders with optional take-profit and stop-loss protection, cancel a submitted batch, set leverage, and list or retrieve past submissions. Read live margin, positions, and open orders by passing `include_trading=true` to Retrieve Account or Retrieve User with `id=me`. Whop's builder fee is added to each order. Hyperliquid perpetuals are currently supported; email support@whop.com to request access. name: Trades x-whop-summary: Submit and track perpetual trades. - 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: > Join a free variant's waitlist, read or cancel your own signups, and manage signups for accounts you are authorized to operate. Joining does not grant membership or charge a payment method. Seller approval runs asynchronously and can charge a saved payment method for a paid variant. name: Waitlist Entries x-whop-summary: Join waitlists and manage customer signups awaiting approval. - 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: > Plans is the former public name for Variants. Existing integrations can keep calling these deprecated endpoints while they migrate; every response points to the matching Variants endpoint. Use the Variants API for all new integrations. Variant IDs retain their existing `plan_` prefix, and the underlying resource is unchanged. name: Plans x-whop-summary: Deprecated compatibility endpoints for variants. - name: Promo Codes x-whop-summary: Discounts that creators configure for checkout. - 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 the caller's 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 period-end cancellation, pause and resume payment collection, extend with free days, apply a promo code mid-cycle, 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 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 Payment Method Domain registers a hostname with a wallet provider so its payment methods can appear at a checkout served from that domain. The domain proves ownership by hosting the provider's association file — for Apple Pay, at `/.well-known/apple-developer-merchantid-domain-association` — and `status` reports whether verification has completed. Use the Payment Method Domains API to register domains for your account or its connected accounts, retry verification once the association file is hosted, and remove domains that should no longer serve wallet payments. A domain a platform shares with its connected accounts at checkout is listed on the platform's account, not on each connected account. Wallet buttons at checkout depend on this: embedded surfaces like the [Express Checkout element](/elements/beta/checkout/expressCheckout) only render Apple Pay, Google Pay and PayPal express on a `verified` domain (first-party whop.com pages are pre-approved). To verify a domain, [create it](/api-reference/beta/payment-method-domains/create-payment-method-domain), host the association file at the path above, then [retry verification](/api-reference/beta/payment-method-domains/verify-payment-method-domain) until `status` is `verified`. name: Payment Method Domains x-whop-summary: >- Domains verified to show wallet payment methods like Apple Pay at checkout. - 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 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: > Partner Referral Requests let partners create referral links and request attribution for an existing business or enrolled partner, with manual requests requiring recipient approval. name: Partner Referral Requests x-whop-summary: Request business or partner attribution and manage approval. - 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/{id}`. 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 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 Person is an identity-linked profile of a visitor or customer of an account, assembled from every [event](/api-reference/beta/events/event) the person generated — pixel page views, ad clicks, leads, identifies, and payments. Each profile carries the person's known identities (names, emails, phones, user IDs), purchase history and LTV, geo/device profile, traffic sources, and the first and last marketing touches that reached them. Use the People API to list and segment the people of an account — filter by activity, purchases, traffic source, location, or marketing touch, and sort by value — or 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/beta/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/beta/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 Ad is the individual creative unit delivered by an [ad group](/api-reference/beta/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: > A conversion value rule allows you to report accurate conversion values to Whop while modifying how those values are sent to ad networks. Rules belong to an account and can apply to an account, an ad campaign, an ad group, or an ad. Each rule contains targets and events that share one value adjustment. Every selected event applies to every selected target. Create, retrieve, edit, delete, pause, or resume one rule by its ID. Create may set an initial active or paused status. Edits keep that status. Filter the list with resource_id to find rules overlapping a campaign, ad group, or ad. Every target must support every selected event; Google does not support named custom events. Create and edit accept replace_rule_ids to replace only the overlapping selections in the same transaction. Other selections keep their values. Remaining selections may split into separate rules so every event still applies to every target. Broader rules remain as fallbacks for other items; the most specific rule applies. Rules with no remaining selections are paused. Unpause automatically replaces overlapping selections using the same behavior as create and edit: other selections keep their values, and broader rules remain as defaults. Resuming an already-active rule makes no changes. Each write succeeds or fails as one transaction. Use Idempotency-Key to safely retry POST requests. Each conversion send attempt uses the rules saved at that time, including retries. name: Ad Conversion Value Rules x-whop-summary: Modify how conversion events are delivered to ad networks. - description: > An Ad Campaign is the top-level container for paid ads on an ad network. It sets the platform, objective, and budget strategy shared by its [ad groups](/api-reference/beta/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/beta/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: Platform, objective, and budget for a set of ads. - description: > An Ad Group sits inside an [ad campaign](/api-reference/beta/ad-campaigns/ad-campaign) and controls delivery for [ads](/api-reference/beta/ads/ad). It sets the audience, placements, schedule, budget, and optimization goal 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. It can also search the ad platform's targeting taxonomy for options to target and estimate how many people a draft targeting spec can reach. name: Ad Groups x-whop-summary: Audience, placements, and schedule within a campaign. - description: > An Audience is a reusable group of people to include or exclude when targeting ads. Build custom audiences from customer lists, Whop People data, or social engagement, and create lookalikes to reach people similar to an existing audience. Use the Audiences API to create, list, and delete audiences and monitor asynchronous processing. Meta engagement sources include videos, lead forms, Instagram profiles, and Facebook pages. Engagement membership updates on Meta; Whop People audiences can refresh automatically or keep a snapshot. name: Audiences x-whop-summary: Reusable targeting lists for ad groups. - 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 External Account represents a profile on another platform connected to a Whop account or user, such as a Facebook page, Instagram account, or TikTok account. Connecting an external account lets Whop run [ads](/api-reference/beta/ads/ad) under that profile's identity and promote its existing posts. External account IDs are prefixed `sacc_`. Use the External Accounts API to list connected accounts, create a Whop-managed Facebook page, start an OAuth connection, disconnect an external account, and list a connected profile's posts or a Facebook page's lead forms. name: External Accounts x-whop-summary: Profiles on other platforms connected 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: > An App is software you build on Whop. It can be a hosted web app served at `.whop.site` 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. Logs are retained for 7 days and can be filtered by build, level, time window, and message text. 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: > A Domain is a hostname an account buys through Whop or connects from another registrar, and assigns to one of its apps. Creating a domain buys it unless `mode` is `external`: pay at its `purchase_url`, or set `payment_method_id` to charge a saved card, and Whop registers the domain and runs its DNS. 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 for it. An unpaid domain stops serving its app when it expires but stays renewable at `purchase_url` until the registry's grace period ends, and is then removed. A connected domain returns DNS records to publish instead. Verification and certificates run automatically, and unverified claims expire after 48 hours. A claim doesn't reserve the hostname. Either kind serves its app once its hostname and certificate are active. To find a domain to buy, pass `search` to List Domains or a hostname to Retrieve Domain. name: Domains x-whop-summary: Custom domains assigned to hosted apps. - 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 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: > 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 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: > Experiments belong to an account. Use `account_id` to select the owning account, or `internal` for Whop's platform experiments. Reading and managing account experiments requires `experiment:read` or `experiment:manage`; internal configuration requires Whop internal access. Exposure is callable without authentication. Create a draft, configure treatment weights and targeting, then activate, pause, or end it. Treatments occupy stable percentage ranges; the remainder is control. Growing an allocation preserves existing treatment assignments. Optional `related_resource` references attach experiments, control, and variants to resources owned by the account. Bindings cannot change after first activation. `GET /experiments/exposures` evaluates and records exposure. Ownership is separate from `subject` identity: `subject[user_id]`, `subject[account_id]`, and `subject[anonymous_id]` supply the experiment's bucketing unit. Internal user identity comes from the authenticated session. Resolved authentication is recorded on the event separately from the subject. Pass a flag key and its account, or a globally unique experiment ID. Without a flag key, evaluation returns active experiments in the account and related resource scope. Account experiments run without a reporting provider. Statistical results and the metric catalog currently remain internal. Configuration responses include an assignment seed and revision for consumers that cache experiment definitions. name: Experiments x-whop-summary: >- Feature flags and A/B experiments for gradual rollout and statistical measurement. - 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 internally. 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 internal 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 time series of points for an account or user over a time range. 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. The `funnel` metric measures 2 to 10 ordered events per person. Its first matching event inside from/to anchors the cohort, breakdown and conversion window; later entries do not restart it. Intervening events are allowed, and conversions may occur after to. Funnel values are final conversion percentages; steps include counts and cumulative conversion percentages. Experiment funnels use experiment.exposure as step 1 and breakdown_by=variant. Pass steps using bracket parameters such as steps[1][event]=pixel.page&steps[1][page]=/pricing*&steps[2][event]=payment.completed. operationId: retrieveMetricTimeSeries parameters: - description: The account this query concerns, for example biz_AbC123. 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. Each metric lists its accepted values in the catalog. in: query name: snapshot_window required: false schema: enum: - 7d - 28d - 30d 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: >- 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. Consecutive one-based steps encoded as steps[1][event], steps[1][page], steps[2][event], and so on. Values are scalar strings, never JSON. 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 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. 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-10-06-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 ````