Error

A valid request URL is required to generate request examples

{
  "success": true,
  "data": {
    "id": "containment",
    "unit": "percent",
    "format": "0.0%",
    "total": 0.79,
    "delta": 0.03,
    "n": 1240,
    "series": [
      {
        "bucket": "2026-06-29T00:00:00.000Z",
        "value": 0.77,
        "n": 180
      },
      {
        "bucket": "2026-06-30T00:00:00.000Z",
        "value": 0.8,
        "n": 205
      },
      {
        "bucket": "2026-07-01T00:00:00.000Z",
        "value": 0.81,
        "n": 198
      }
    ]
  }
}

{
  "type": "about:blank",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>",
  "code": "<string>",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "type": "about:blank",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>",
  "code": "<string>",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "type": "about:blank",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>",
  "code": "<string>",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "type": "about:blank",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>",
  "code": "<string>",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

Observe

Query one metric over a filter window

Compute a single metric over a time window and a set of filter lenses, returning { series[], total, delta, n, unit, format } (plus a breakdown[] for non-scalar metrics). total is the scalar value for count/ratio/avg metrics and null for distribution/percentile metrics (whose per-slice numbers live in breakdown[]). n is the honest sample count behind the number — a client should refuse to over-claim below a metric’s minimum-n. series[] is the tz-aware per-bucket trend (empty for point-in-time backlog metrics). Filters (all optional): from/to bound the window as a half-open [from, to) range (RFC3339); tz is the IANA timezone used to bucket the series (default UTC), which fixes day-boundary drift; bucket sets the series granularity (day|week|month|hour, default day); channel restricts to one channel; agent and queue are INDEPENDENT lenses (both may be set — they AND together, one narrowing to a single agent, the other to a single queue); minN overrides the metric’s low-volume suppression floor. Applying a lens the metric does not declare (see the catalog’s dimensions) is a 400. compare=true additionally computes delta = current minus the immediately preceding equal-length window (scalar metrics with a bounded window only; otherwise delta is null).

GET

metrics

{id}

Error

A valid request URL is required to generate request examples

{
  "success": true,
  "data": {
    "id": "containment",
    "unit": "percent",
    "format": "0.0%",
    "total": 0.79,
    "delta": 0.03,
    "n": 1240,
    "series": [
      {
        "bucket": "2026-06-29T00:00:00.000Z",
        "value": 0.77,
        "n": 180
      },
      {
        "bucket": "2026-06-30T00:00:00.000Z",
        "value": 0.8,
        "n": 205
      },
      {
        "bucket": "2026-07-01T00:00:00.000Z",
        "value": 0.81,
        "n": 198
      }
    ]
  }
}

{
  "type": "about:blank",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>",
  "code": "<string>",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "type": "about:blank",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>",
  "code": "<string>",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "type": "about:blank",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>",
  "code": "<string>",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "type": "about:blank",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>",
  "code": "<string>",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

Flowyte secret API key (Authorization: Bearer flowyte_sk_live_…). Scope-gated; is scoped to your organization — a key can never reach another tenant. The listed scopes in each operation's apiKey requirement are the scopes that key must hold. The tokenUrl is nominal: keys are minted in the dashboard.

Path Parameters

string

required

A metric id from the catalog (e.g. containment). Unknown ids → 404.

Query Parameters

from

string<date-time>

Window start (RFC3339); window is half-open [from, to).

string<date-time>

Window end (RFC3339, exclusive).

compare

enum<string>

Also compute delta = current minus a baseline window (scalar call metrics with a bounded window only). Modes: prev (or any truthy legacy value — true/1/yes) = the immediately preceding EQUAL-LENGTH window [from-Δ, from); lastweek = the SAME-length window shifted back exactly 7 days [from-7d, to-7d] (same-period-last-week). Blank/other = no delta.

Available options:

prev,

lastweek,

true

string

IANA timezone for series bucketing (default UTC). Fixes day-boundary drift.

bucket

enum<string>

Series granularity (default day).

Available options:

day,

week,

month,

hour

channel

enum<string>

Restrict to one channel.

Available options:

voice,

chat,

sms

agent

string

Restrict to one agent id. Independent of queue (they AND together).

queue

string

Restrict to one queue id. Independent of agent (they AND together).

minN

integer

Override the metric low-volume suppression floor.

Required range: x >= 0

Response

The compiled metric result.

success

boolean

required

data

object

required

The compiled result of queryMetric. total is the scalar value for count/ratio/avg metrics and null for distribution/percentile metrics (whose per-slice numbers live in breakdown[]). n is the honest sample count behind the number. series[] is the tz-aware per-bucket trend (empty for point-in-time backlog metrics). delta is populated only when ?compare= was requested on a scalar metric with a bounded window.

Show child attributes

message

string

errors

object[]

Show child attributes

The Observe metric catalog (self-describing registry)The conversations behind a metric number (drill-down)

Using the API

Endpoints

Query one metric over a filter window

Authorizations

Path Parameters

Query Parameters

Response