---
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 over a time range. The `market_prices` metric is public and requires no authentication.

## Query parameters

- `account_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'

## 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.
        - `value` number, nullable, required — The metric's value for this entry.
      - `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 (e.g. conversions returns window count / unique-people / value per entry — uniques only exist at window level and cannot be summed from points).
      - `name` string, required — The property value the total is for.
      - `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

---

[API](https://skmtc.net/whop/apis/whop-api.md) · [All operations](https://skmtc.net/whop/apis/whop-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/whop/whop-api/versions/db0883548bc5/schema)