---
title: "Retrieve Metric"
method: GET
path: "/stats/{metric}"
tags: ["Stats"]
---

# Retrieve Metric

`GET /stats/{metric}`

Retrieves a metric as a time series of points for an account or user over a time range. 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.

## Query parameters

- `account_id` string
- `user_id` string
- `from` string, required
- `to` string, required
- `interval` 'minute' | 'five_minutes' | 'thirty_minutes' | 'hour' | 'day' | 'week' | 'month' | 'year'
- `breakdown_by` string
- `convert_to` string
- `currency` string
- `time_zone` string
- `payment_method` string
- `card_network` string
- `dispute_reason` string
- `source` string
- `hostname` string
- `page` string
- `device_type` string
- `country_code` string
- `event_name` string
- `event_type` 'page_view' | 'checkout_start' | 'other'
- `custom_name` string
- `segment` string
- `category` string
- `merchant` string
- `fee_type` string
- `product` string
- `status` string
- `access_level` string
- `most_recent_action` string
- `referred_user_id` string
- `ad_campaign_ids` string[]
- `ad_group_ids` string[]
- `ad_ids` string[]
- `snapshot_window` '7d' | '28d' | '30d'
- `event` string
- `conversion_window` string
- `mature_only` boolean
- `steps` object
  - `1` FunnelStep, required
    - `app_build_id` string — The Whop app build ID attached to the event. Comma-separated alternatives are ORed; different filters are ANDed.
    - `app_id` string — The event's app id. Comma-separated alternatives are ORed; different filters are ANDed.
    - `browser` string — The event's browser. Comma-separated alternatives are ORed; different filters are ANDed.
    - `city` string — The event's city. Comma-separated alternatives are ORed; different filters are ANDed.
    - `country` string — The event's country. Comma-separated alternatives are ORed; different filters are ANDed.
    - `custom_name` string — The custom event name. Requires event=pixel.custom. Comma-separated alternatives are ORed; different filters are ANDed.
    - `device` string — The event's device. Comma-separated alternatives are ORed; different filters are ANDed.
    - `event` string, required — The event name, such as pixel.page, pixel.custom, experiment.exposure, or payment.completed. Exactly one event per step.
    - `experiment_id` string — An experiment ID owned by account_id. Requires event=experiment.exposure. Comma-separated alternatives are ORed; different filters are ANDed.
    - `hostname` string — The event's hostname. Comma-separated alternatives are ORed; different filters are ANDed.
    - `os` string — The event's os. Comma-separated alternatives are ORed; different filters are ANDed.
    - `page` string — 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.
    - `plan_id` string — The plan ID attached to the event. Comma-separated alternatives are ORed; different filters are ANDed.
    - `product_id` string — The product ID attached to the event. Comma-separated alternatives are ORed; different filters are ANDed.
    - `source` string — The Whop ad-click source of this page view, not conversion attribution. Use whop:* for any Whop ad click, whop:<campaign>:* for a campaign, or whop:<campaign>:<group>:<ad> 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.
    - `utm_source` string — The event's utm source. Comma-separated alternatives are ORed; different filters are ANDed.
    - `variant` string — The exposed variant name. Requires event=experiment.exposure. Comma-separated alternatives are ORed; different filters are ANDed.
  - `2` FunnelStep, required
    - `app_build_id` string — The Whop app build ID attached to the event. Comma-separated alternatives are ORed; different filters are ANDed.
    - `app_id` string — The event's app id. Comma-separated alternatives are ORed; different filters are ANDed.
    - `browser` string — The event's browser. Comma-separated alternatives are ORed; different filters are ANDed.
    - `city` string — The event's city. Comma-separated alternatives are ORed; different filters are ANDed.
    - `country` string — The event's country. Comma-separated alternatives are ORed; different filters are ANDed.
    - `custom_name` string — The custom event name. Requires event=pixel.custom. Comma-separated alternatives are ORed; different filters are ANDed.
    - `device` string — The event's device. Comma-separated alternatives are ORed; different filters are ANDed.
    - `event` string, required — The event name, such as pixel.page, pixel.custom, experiment.exposure, or payment.completed. Exactly one event per step.
    - `experiment_id` string — An experiment ID owned by account_id. Requires event=experiment.exposure. Comma-separated alternatives are ORed; different filters are ANDed.
    - `hostname` string — The event's hostname. Comma-separated alternatives are ORed; different filters are ANDed.
    - `os` string — The event's os. Comma-separated alternatives are ORed; different filters are ANDed.
    - `page` string — 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.
    - `plan_id` string — The plan ID attached to the event. Comma-separated alternatives are ORed; different filters are ANDed.
    - `product_id` string — The product ID attached to the event. Comma-separated alternatives are ORed; different filters are ANDed.
    - `source` string — The Whop ad-click source of this page view, not conversion attribution. Use whop:* for any Whop ad click, whop:<campaign>:* for a campaign, or whop:<campaign>:<group>:<ad> 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.
    - `utm_source` string — The event's utm source. Comma-separated alternatives are ORed; different filters are ANDed.
    - `variant` string — The exposed variant name. Requires event=experiment.exposure. Comma-separated alternatives are ORed; different filters are ANDed.
  - `3` FunnelStep
    - `app_build_id` string — The Whop app build ID attached to the event. Comma-separated alternatives are ORed; different filters are ANDed.
    - `app_id` string — The event's app id. Comma-separated alternatives are ORed; different filters are ANDed.
    - `browser` string — The event's browser. Comma-separated alternatives are ORed; different filters are ANDed.
    - `city` string — The event's city. Comma-separated alternatives are ORed; different filters are ANDed.
    - `country` string — The event's country. Comma-separated alternatives are ORed; different filters are ANDed.
    - `custom_name` string — The custom event name. Requires event=pixel.custom. Comma-separated alternatives are ORed; different filters are ANDed.
    - `device` string — The event's device. Comma-separated alternatives are ORed; different filters are ANDed.
    - `event` string, required — The event name, such as pixel.page, pixel.custom, experiment.exposure, or payment.completed. Exactly one event per step.
    - `experiment_id` string — An experiment ID owned by account_id. Requires event=experiment.exposure. Comma-separated alternatives are ORed; different filters are ANDed.
    - `hostname` string — The event's hostname. Comma-separated alternatives are ORed; different filters are ANDed.
    - `os` string — The event's os. Comma-separated alternatives are ORed; different filters are ANDed.
    - `page` string — 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.
    - `plan_id` string — The plan ID attached to the event. Comma-separated alternatives are ORed; different filters are ANDed.
    - `product_id` string — The product ID attached to the event. Comma-separated alternatives are ORed; different filters are ANDed.
    - `source` string — The Whop ad-click source of this page view, not conversion attribution. Use whop:* for any Whop ad click, whop:<campaign>:* for a campaign, or whop:<campaign>:<group>:<ad> 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.
    - `utm_source` string — The event's utm source. Comma-separated alternatives are ORed; different filters are ANDed.
    - `variant` string — The exposed variant name. Requires event=experiment.exposure. Comma-separated alternatives are ORed; different filters are ANDed.
  - `4` FunnelStep
    - `app_build_id` string — The Whop app build ID attached to the event. Comma-separated alternatives are ORed; different filters are ANDed.
    - `app_id` string — The event's app id. Comma-separated alternatives are ORed; different filters are ANDed.
    - `browser` string — The event's browser. Comma-separated alternatives are ORed; different filters are ANDed.
    - `city` string — The event's city. Comma-separated alternatives are ORed; different filters are ANDed.
    - `country` string — The event's country. Comma-separated alternatives are ORed; different filters are ANDed.
    - `custom_name` string — The custom event name. Requires event=pixel.custom. Comma-separated alternatives are ORed; different filters are ANDed.
    - `device` string — The event's device. Comma-separated alternatives are ORed; different filters are ANDed.
    - `event` string, required — The event name, such as pixel.page, pixel.custom, experiment.exposure, or payment.completed. Exactly one event per step.
    - `experiment_id` string — An experiment ID owned by account_id. Requires event=experiment.exposure. Comma-separated alternatives are ORed; different filters are ANDed.
    - `hostname` string — The event's hostname. Comma-separated alternatives are ORed; different filters are ANDed.
    - `os` string — The event's os. Comma-separated alternatives are ORed; different filters are ANDed.
    - `page` string — 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.
    - `plan_id` string — The plan ID attached to the event. Comma-separated alternatives are ORed; different filters are ANDed.
    - `product_id` string — The product ID attached to the event. Comma-separated alternatives are ORed; different filters are ANDed.
    - `source` string — The Whop ad-click source of this page view, not conversion attribution. Use whop:* for any Whop ad click, whop:<campaign>:* for a campaign, or whop:<campaign>:<group>:<ad> 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.
    - `utm_source` string — The event's utm source. Comma-separated alternatives are ORed; different filters are ANDed.
    - `variant` string — The exposed variant name. Requires event=experiment.exposure. Comma-separated alternatives are ORed; different filters are ANDed.
  - `5` FunnelStep
    - `app_build_id` string — The Whop app build ID attached to the event. Comma-separated alternatives are ORed; different filters are ANDed.
    - `app_id` string — The event's app id. Comma-separated alternatives are ORed; different filters are ANDed.
    - `browser` string — The event's browser. Comma-separated alternatives are ORed; different filters are ANDed.
    - `city` string — The event's city. Comma-separated alternatives are ORed; different filters are ANDed.
    - `country` string — The event's country. Comma-separated alternatives are ORed; different filters are ANDed.
    - `custom_name` string — The custom event name. Requires event=pixel.custom. Comma-separated alternatives are ORed; different filters are ANDed.
    - `device` string — The event's device. Comma-separated alternatives are ORed; different filters are ANDed.
    - `event` string, required — The event name, such as pixel.page, pixel.custom, experiment.exposure, or payment.completed. Exactly one event per step.
    - `experiment_id` string — An experiment ID owned by account_id. Requires event=experiment.exposure. Comma-separated alternatives are ORed; different filters are ANDed.
    - `hostname` string — The event's hostname. Comma-separated alternatives are ORed; different filters are ANDed.
    - `os` string — The event's os. Comma-separated alternatives are ORed; different filters are ANDed.
    - `page` string — 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.
    - `plan_id` string — The plan ID attached to the event. Comma-separated alternatives are ORed; different filters are ANDed.
    - `product_id` string — The product ID attached to the event. Comma-separated alternatives are ORed; different filters are ANDed.
    - `source` string — The Whop ad-click source of this page view, not conversion attribution. Use whop:* for any Whop ad click, whop:<campaign>:* for a campaign, or whop:<campaign>:<group>:<ad> 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.
    - `utm_source` string — The event's utm source. Comma-separated alternatives are ORed; different filters are ANDed.
    - `variant` string — The exposed variant name. Requires event=experiment.exposure. Comma-separated alternatives are ORed; different filters are ANDed.
  - `6` FunnelStep
    - `app_build_id` string — The Whop app build ID attached to the event. Comma-separated alternatives are ORed; different filters are ANDed.
    - `app_id` string — The event's app id. Comma-separated alternatives are ORed; different filters are ANDed.
    - `browser` string — The event's browser. Comma-separated alternatives are ORed; different filters are ANDed.
    - `city` string — The event's city. Comma-separated alternatives are ORed; different filters are ANDed.
    - `country` string — The event's country. Comma-separated alternatives are ORed; different filters are ANDed.
    - `custom_name` string — The custom event name. Requires event=pixel.custom. Comma-separated alternatives are ORed; different filters are ANDed.
    - `device` string — The event's device. Comma-separated alternatives are ORed; different filters are ANDed.
    - `event` string, required — The event name, such as pixel.page, pixel.custom, experiment.exposure, or payment.completed. Exactly one event per step.
    - `experiment_id` string — An experiment ID owned by account_id. Requires event=experiment.exposure. Comma-separated alternatives are ORed; different filters are ANDed.
    - `hostname` string — The event's hostname. Comma-separated alternatives are ORed; different filters are ANDed.
    - `os` string — The event's os. Comma-separated alternatives are ORed; different filters are ANDed.
    - `page` string — 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.
    - `plan_id` string — The plan ID attached to the event. Comma-separated alternatives are ORed; different filters are ANDed.
    - `product_id` string — The product ID attached to the event. Comma-separated alternatives are ORed; different filters are ANDed.
    - `source` string — The Whop ad-click source of this page view, not conversion attribution. Use whop:* for any Whop ad click, whop:<campaign>:* for a campaign, or whop:<campaign>:<group>:<ad> 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.
    - `utm_source` string — The event's utm source. Comma-separated alternatives are ORed; different filters are ANDed.
    - `variant` string — The exposed variant name. Requires event=experiment.exposure. Comma-separated alternatives are ORed; different filters are ANDed.
  - `7` FunnelStep
    - `app_build_id` string — The Whop app build ID attached to the event. Comma-separated alternatives are ORed; different filters are ANDed.
    - `app_id` string — The event's app id. Comma-separated alternatives are ORed; different filters are ANDed.
    - `browser` string — The event's browser. Comma-separated alternatives are ORed; different filters are ANDed.
    - `city` string — The event's city. Comma-separated alternatives are ORed; different filters are ANDed.
    - `country` string — The event's country. Comma-separated alternatives are ORed; different filters are ANDed.
    - `custom_name` string — The custom event name. Requires event=pixel.custom. Comma-separated alternatives are ORed; different filters are ANDed.
    - `device` string — The event's device. Comma-separated alternatives are ORed; different filters are ANDed.
    - `event` string, required — The event name, such as pixel.page, pixel.custom, experiment.exposure, or payment.completed. Exactly one event per step.
    - `experiment_id` string — An experiment ID owned by account_id. Requires event=experiment.exposure. Comma-separated alternatives are ORed; different filters are ANDed.
    - `hostname` string — The event's hostname. Comma-separated alternatives are ORed; different filters are ANDed.
    - `os` string — The event's os. Comma-separated alternatives are ORed; different filters are ANDed.
    - `page` string — 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.
    - `plan_id` string — The plan ID attached to the event. Comma-separated alternatives are ORed; different filters are ANDed.
    - `product_id` string — The product ID attached to the event. Comma-separated alternatives are ORed; different filters are ANDed.
    - `source` string — The Whop ad-click source of this page view, not conversion attribution. Use whop:* for any Whop ad click, whop:<campaign>:* for a campaign, or whop:<campaign>:<group>:<ad> 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.
    - `utm_source` string — The event's utm source. Comma-separated alternatives are ORed; different filters are ANDed.
    - `variant` string — The exposed variant name. Requires event=experiment.exposure. Comma-separated alternatives are ORed; different filters are ANDed.
  - `8` FunnelStep
    - `app_build_id` string — The Whop app build ID attached to the event. Comma-separated alternatives are ORed; different filters are ANDed.
    - `app_id` string — The event's app id. Comma-separated alternatives are ORed; different filters are ANDed.
    - `browser` string — The event's browser. Comma-separated alternatives are ORed; different filters are ANDed.
    - `city` string — The event's city. Comma-separated alternatives are ORed; different filters are ANDed.
    - `country` string — The event's country. Comma-separated alternatives are ORed; different filters are ANDed.
    - `custom_name` string — The custom event name. Requires event=pixel.custom. Comma-separated alternatives are ORed; different filters are ANDed.
    - `device` string — The event's device. Comma-separated alternatives are ORed; different filters are ANDed.
    - `event` string, required — The event name, such as pixel.page, pixel.custom, experiment.exposure, or payment.completed. Exactly one event per step.
    - `experiment_id` string — An experiment ID owned by account_id. Requires event=experiment.exposure. Comma-separated alternatives are ORed; different filters are ANDed.
    - `hostname` string — The event's hostname. Comma-separated alternatives are ORed; different filters are ANDed.
    - `os` string — The event's os. Comma-separated alternatives are ORed; different filters are ANDed.
    - `page` string — 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.
    - `plan_id` string — The plan ID attached to the event. Comma-separated alternatives are ORed; different filters are ANDed.
    - `product_id` string — The product ID attached to the event. Comma-separated alternatives are ORed; different filters are ANDed.
    - `source` string — The Whop ad-click source of this page view, not conversion attribution. Use whop:* for any Whop ad click, whop:<campaign>:* for a campaign, or whop:<campaign>:<group>:<ad> 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.
    - `utm_source` string — The event's utm source. Comma-separated alternatives are ORed; different filters are ANDed.
    - `variant` string — The exposed variant name. Requires event=experiment.exposure. Comma-separated alternatives are ORed; different filters are ANDed.
  - `9` FunnelStep
    - `app_build_id` string — The Whop app build ID attached to the event. Comma-separated alternatives are ORed; different filters are ANDed.
    - `app_id` string — The event's app id. Comma-separated alternatives are ORed; different filters are ANDed.
    - `browser` string — The event's browser. Comma-separated alternatives are ORed; different filters are ANDed.
    - `city` string — The event's city. Comma-separated alternatives are ORed; different filters are ANDed.
    - `country` string — The event's country. Comma-separated alternatives are ORed; different filters are ANDed.
    - `custom_name` string — The custom event name. Requires event=pixel.custom. Comma-separated alternatives are ORed; different filters are ANDed.
    - `device` string — The event's device. Comma-separated alternatives are ORed; different filters are ANDed.
    - `event` string, required — The event name, such as pixel.page, pixel.custom, experiment.exposure, or payment.completed. Exactly one event per step.
    - `experiment_id` string — An experiment ID owned by account_id. Requires event=experiment.exposure. Comma-separated alternatives are ORed; different filters are ANDed.
    - `hostname` string — The event's hostname. Comma-separated alternatives are ORed; different filters are ANDed.
    - `os` string — The event's os. Comma-separated alternatives are ORed; different filters are ANDed.
    - `page` string — 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.
    - `plan_id` string — The plan ID attached to the event. Comma-separated alternatives are ORed; different filters are ANDed.
    - `product_id` string — The product ID attached to the event. Comma-separated alternatives are ORed; different filters are ANDed.
    - `source` string — The Whop ad-click source of this page view, not conversion attribution. Use whop:* for any Whop ad click, whop:<campaign>:* for a campaign, or whop:<campaign>:<group>:<ad> 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.
    - `utm_source` string — The event's utm source. Comma-separated alternatives are ORed; different filters are ANDed.
    - `variant` string — The exposed variant name. Requires event=experiment.exposure. Comma-separated alternatives are ORed; different filters are ANDed.
  - `10` FunnelStep
    - `app_build_id` string — The Whop app build ID attached to the event. Comma-separated alternatives are ORed; different filters are ANDed.
    - `app_id` string — The event's app id. Comma-separated alternatives are ORed; different filters are ANDed.
    - `browser` string — The event's browser. Comma-separated alternatives are ORed; different filters are ANDed.
    - `city` string — The event's city. Comma-separated alternatives are ORed; different filters are ANDed.
    - `country` string — The event's country. Comma-separated alternatives are ORed; different filters are ANDed.
    - `custom_name` string — The custom event name. Requires event=pixel.custom. Comma-separated alternatives are ORed; different filters are ANDed.
    - `device` string — The event's device. Comma-separated alternatives are ORed; different filters are ANDed.
    - `event` string, required — The event name, such as pixel.page, pixel.custom, experiment.exposure, or payment.completed. Exactly one event per step.
    - `experiment_id` string — An experiment ID owned by account_id. Requires event=experiment.exposure. Comma-separated alternatives are ORed; different filters are ANDed.
    - `hostname` string — The event's hostname. Comma-separated alternatives are ORed; different filters are ANDed.
    - `os` string — The event's os. Comma-separated alternatives are ORed; different filters are ANDed.
    - `page` string — 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.
    - `plan_id` string — The plan ID attached to the event. Comma-separated alternatives are ORed; different filters are ANDed.
    - `product_id` string — The product ID attached to the event. Comma-separated alternatives are ORed; different filters are ANDed.
    - `source` string — The Whop ad-click source of this page view, not conversion attribution. Use whop:* for any Whop ad click, whop:<campaign>:* for a campaign, or whop:<campaign>:<group>:<ad> 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.
    - `utm_source` string — The event's utm source. Comma-separated alternatives are ORed; different filters are ANDed.
    - `variant` string — The exposed variant name. Requires event=experiment.exposure. Comma-separated alternatives are ORed; different filters are ANDed.
- `compare_to` string
- `confidence_level` number
- `contactable` boolean
- `has_purchased` boolean
- `first_seen_after` string, date-time
- `first_seen_before` string, date-time
- `last_seen_after` string, date-time
- `last_seen_before` string, date-time
- `first_seen_within_days` integer
- `last_seen_within_days` integer
- `known` boolean
- `has_email` boolean
- `has_phone` boolean
- `ltv_gt` number
- `ltv_gte` number
- `ltv_lt` number
- `ltv_lte` number
- `aov_gt` number
- `aov_gte` number
- `aov_lt` number
- `aov_lte` number
- `purchase_count_gt` number
- `purchase_count_gte` number
- `purchase_count_lt` number
- `purchase_count_lte` number
- `event_count_gt` number
- `event_count_gte` number
- `event_count_lt` number
- `event_count_lte` number

## Response `200`

a user-scoped metric via a scoped OAuth token

- object
  - `data` object, required
    - `currency` string, nullable — ISO currency the values are denominated in. Present for currency-unit metrics: the convert_to currency, or usd.
    - `points` object[], required — One entry per period, oldest first.
      - `breakdown` object[] — Present only when broken down: one entry per property value in this period.
        - `name` string, required — The property value, for example usd or visa.
        - `steps` FunnelStepResult[] — Present for the funnel metric. People reaching each step in order, starting with the entry step.
          - `conversion_rate` number, nullable, required — The percentage of first-step entrants reaching this step; null when there are no entrants.
          - `count` integer, required — The number of distinct people reaching this step.
          - `step` integer, required — The one-based step number.
        - `value` number, nullable, required — The metric's value for this entry.
      - `steps` FunnelStepResult[] — Present for the funnel metric. People reaching each step in order, starting with the entry step.
        - `conversion_rate` number, nullable, required — The percentage of first-step entrants reaching this step; null when there are no entrants.
        - `count` integer, required — The number of distinct people reaching this step.
        - `step` integer, required — The one-based step number.
      - `timestamp` integer, required — Unix timestamp (seconds) of the period start.
      - `value` number, nullable, required — The metric's value for this period, in the metric's unit.
    - `totals` object[], nullable — 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.
      - `comparison` FunnelComparison, nullable — Funnel only. Present when compare_to is supplied; null on the baseline itself. Comparisons are descriptive and do not establish causation.
        - `baseline` string, required — The reference group's name.
        - `difference_confidence_interval` FunnelConfidenceInterval, nullable, required
          - `lower` number, required — The lower confidence bound, in percent or percentage points for a difference.
          - `upper` number, required — The upper confidence bound, in percent or percentage points for a difference.
        - `difference_percentage_points` number, required — This group's conversion percentage minus the baseline's.
        - `relative_lift_percent` number, nullable, required — Relative conversion improvement in percent; null if baseline conversion is zero.
      - `confidence_interval` FunnelConfidenceInterval, nullable
        - `lower` number, required — The lower confidence bound, in percent or percentage points for a difference.
        - `upper` number, required — The upper confidence bound, in percent or percentage points for a difference.
      - `name` string, required — The property value this total is for, or the metric's name when it isn't split by a property.
      - `steps` FunnelStepResult[] — Present for the funnel metric. People reaching each step in order, starting with the entry step.
        - `conversion_rate` number, nullable, required — The percentage of first-step entrants reaching this step; null when there are no entrants.
        - `count` integer, required — The number of distinct people reaching this step.
        - `step` integer, required — The one-based step number.
      - `value` number, nullable, required — The metric's whole-window value for this entry.

## Other responses

- `400` — Invalid Parameters
- `401` — Unauthorized
- `403` — Forbidden
- `404` — Resource not found

## Changes

> 74 revisions in range; 1 not diffed.

- **2026-09-27** `78e1ed7366cd` — 2 info
  - the security scope `stats:read` was added to the endpoint's security scheme `bearerAuth`
  - the security scope `ad_campaign:read` was removed from the endpoint's security scheme `bearerAuth`
- **2026-09-26** `73dd0533cd81` — 2 info
  - the security scope `stats:read` was added to the endpoint's security scheme `bearerAuth`
  - the security scope `ad_campaign:read` was removed from the endpoint's security scheme `bearerAuth`
- **2026-09-25** `86b97292852d` — 2 info
  - the security scope `stats:read` was added to the endpoint's security scheme `bearerAuth`
  - the security scope `ad_campaign:read` was removed from the endpoint's security scheme `bearerAuth`
- **2026-09-25** `c1dceb26e505` — 2 info
  - the security scope `stats:read` was added to the endpoint's security scheme `bearerAuth`
  - the security scope `ad_campaign:read` was removed from the endpoint's security scheme `bearerAuth`
- **2026-09-24** `7fcefabddb0a` — 2 info
  - the security scope `stats:read` was added to the endpoint's security scheme `bearerAuth`
  - the security scope `ad_campaign:read` was removed from the endpoint's security scheme `bearerAuth`

[Full history](https://skmtc.dev/whop/apis/whop-api/changes/stats/:metric/get.md)

---

[API](https://skmtc.dev/whop/apis/whop-api.md) · [All operations](https://skmtc.dev/whop/apis/whop-api/llms.txt) · [OpenAPI document](https://skmtc.dev/whop/apis/whop-api/revisions/78e1ed7366cd?raw)
