---
title: "GET /v1/metrics"
method: GET
path: "/v1/metrics"
---

# GET /v1/metrics

`GET /v1/metrics`

## Request

- The document declares no server URL.
- Auth: one of:
  - HTTP bearer
  - API key in cookie `__Secure-better-auth.session_token`

The organisation's usage over a window: totals, a previous-window comparison, and a bucketed series.

## Query parameters

- `range` '24h' | '7d' | '30d', required: How far back the metrics window reaches. Decides the bucket width below.

## Response `200`

The request has succeeded.

- OrgMetrics
  - `range` '24h' | '7d' | '30d', required: How far back the metrics window reaches. Decides the bucket width below.
  - `received` Metric, required
    - `value` number, double, required: The headline for the window — a sum for counts, a ratio for the rate.
    - `previous` number, double, required: The same figure over the preceding window of equal length. `0` means "no comparison".
    - `points` MetricPoint[], required: Oldest bucket first; the newest is the one still in progress.
      - `at` string, date-time, required: Bucket start, UTC.
      - `label` string, required: Pre-formatted for the axis and tooltip, because only the server knows the bucket width: `24h` buckets are hours (`13:00`), `7d` buckets are weekdays (`Mon`), `30d` buckets are `Day 1` … `Day 30` with Day 1 the oldest.
      - `value` number, double, required
  - `sent` Metric, required
    - `value` number, double, required: The headline for the window — a sum for counts, a ratio for the rate.
    - `previous` number, double, required: The same figure over the preceding window of equal length. `0` means "no comparison".
    - `points` MetricPoint[], required: Oldest bucket first; the newest is the one still in progress.
      - `at` string, date-time, required: Bucket start, UTC.
      - `label` string, required: Pre-formatted for the axis and tooltip, because only the server knows the bucket width: `24h` buckets are hours (`13:00`), `7d` buckets are weekdays (`Mon`), `30d` buckets are `Day 1` … `Day 30` with Day 1 the oldest.
      - `value` number, double, required
  - `bounced` Metric, required
    - `value` number, double, required: The headline for the window — a sum for counts, a ratio for the rate.
    - `previous` number, double, required: The same figure over the preceding window of equal length. `0` means "no comparison".
    - `points` MetricPoint[], required: Oldest bucket first; the newest is the one still in progress.
      - `at` string, date-time, required: Bucket start, UTC.
      - `label` string, required: Pre-formatted for the axis and tooltip, because only the server knows the bucket width: `24h` buckets are hours (`13:00`), `7d` buckets are weekdays (`Mon`), `30d` buckets are `Day 1` … `Day 30` with Day 1 the oldest.
      - `value` number, double, required
  - `deliveryRate` Metric, required
    - `value` number, double, required: The headline for the window — a sum for counts, a ratio for the rate.
    - `previous` number, double, required: The same figure over the preceding window of equal length. `0` means "no comparison".
    - `points` MetricPoint[], required: Oldest bucket first; the newest is the one still in progress.
      - `at` string, date-time, required: Bucket start, UTC.
      - `label` string, required: Pre-formatted for the axis and tooltip, because only the server knows the bucket width: `24h` buckets are hours (`13:00`), `7d` buckets are weekdays (`Mon`), `30d` buckets are `Day 1` … `Day 30` with Day 1 the oldest.
      - `value` number, double, required
  - `flagged` Metric, required
    - `value` number, double, required: The headline for the window — a sum for counts, a ratio for the rate.
    - `previous` number, double, required: The same figure over the preceding window of equal length. `0` means "no comparison".
    - `points` MetricPoint[], required: Oldest bucket first; the newest is the one still in progress.
      - `at` string, date-time, required: Bucket start, UTC.
      - `label` string, required: Pre-formatted for the axis and tooltip, because only the server knows the bucket width: `24h` buckets are hours (`13:00`), `7d` buckets are weekdays (`Mon`), `30d` buckets are `Day 1` … `Day 30` with Day 1 the oldest.
      - `value` number, double, required
  - `drafted` Metric, required
    - `value` number, double, required: The headline for the window — a sum for counts, a ratio for the rate.
    - `previous` number, double, required: The same figure over the preceding window of equal length. `0` means "no comparison".
    - `points` MetricPoint[], required: Oldest bucket first; the newest is the one still in progress.
      - `at` string, date-time, required: Bucket start, UTC.
      - `label` string, required: Pre-formatted for the axis and tooltip, because only the server knows the bucket width: `24h` buckets are hours (`13:00`), `7d` buckets are weekdays (`Mon`), `30d` buckets are `Day 1` … `Day 30` with Day 1 the oldest.
      - `value` number, double, required

## Other responses

- `default`: An unexpected error response.

---

[API](https://skmtc.dev/foundermail/apis/org.md) - [All operations](https://skmtc.dev/foundermail/apis/org/llms.txt) - [OpenAPI document](https://skmtc.dev/foundermail/apis/org/revisions/8bbb36e378ab?raw)