Skip to main content
GET
/
stats
/
{metric}
Retrieve Metric
curl --request GET \
  --url https://{defaultHost}/stats/{metric} \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "points": [
      {
        "timestamp": 123,
        "value": 123,
        "breakdown": [
          {
            "name": "<string>",
            "value": 123
          }
        ]
      }
    ]
  }
}

Authorizations

​
Authorization
string
header
required

An account API key, account scoped JWT, app API key, or user OAuth token.

Headers

​
Api-Version-Date
string<date>

Pins the request to a dated API version. When omitted, the request uses the original (2025-01-01) request/response shapes, so existing unversioned callers are never broken. Generated SDKs always send the latest version they were built against. An unrecognized value is rejected with a 400. The schemas documented here always describe the latest version.

Example:

"2026-06-20"

Path Parameters

​
metric
string
required

The metric to retrieve, for example net_revenue. Use GET /stats to see every metric key. The metric sets the unit and the properties you can filter or break down by.

Query Parameters

​
account_id
string
required

The account to measure, for example biz_AbC123.

​
from
string<date>
required

Start of the date range (YYYY-MM-DD).

​
to
string<date>
required

End of the date range (YYYY-MM-DD).

​
interval
enum<string>

How wide each point is. Defaults to day. Snapshot metrics are day-only.

Available options:
hour,
day,
week,
month
​
breakdown_by
string

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.

​
convert_to
string

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. Ignored when you filter or break down by currency (those report the original transaction currency, unconverted).

​
currency
string

Filter to transactions made in this original ISO currency, for example eur — reported in that currency, not converted. Pair with breakdown_by=currency to split a metric by currency. Available on metrics that list currency.

​
time_zone
string

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.

​
payment_method
string

Filter to a single payment method, for example card or crypto. Available on metrics that list payment_method.

​
card_network
string

Filter to a single card brand, for example visa. A refinement of payment_method=card. Available on metrics that list card_network.

​
snapshot_window
enum<string>

Trailing window for snapshot metrics. Only accepted by snapshot metrics (each lists its allowed windows in the catalog); defaults to the metric's first supported window. Only 30d today.

Available options:
30d

Response

split into one segment per property value

​
data
object
required