Error

A valid request URL is required to generate request examples

{
  "success": true,
  "data": [
    {
      "id": "conv_9d2f01",
      "agentId": "agt_4f9c2b7e10a24d51",
      "channel": "voice",
      "startedAt": "2026-07-01T15:12:00.000Z",
      "durationS": 210,
      "resolution": "transferred",
      "language": "en",
      "outcome": "transferred",
      "goalCompleted": false,
      "summary": "Caller needed a manager for a billing dispute; transferred.",
      "primaryTopic": "Billing",
      "sentiment": "negative"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 50,
    "totalPages": 3,
    "nextCursor": "eyJjcmVhdGVkQXQiOiIyMDI2LTA3LTAxIn0"
  }
}

{
  "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

The conversations behind a metric number (drill-down)

The conversation rows a metric number is computed from — the drill drawer behind a tile. It applies the SAME filter lenses AND the same counted-conversation predicate as queryMetric, PLUS the metric’s own drill predicate (e.g. Transfers drills only transferred conversations), so the list always matches the number. Rows are shaped like ConversationListItem. Only metrics whose catalog hasDrilldown is true support this (others → 400). Pagination is KEYSET on (createdAt, id) DESC for stability under concurrent inserts: pass the returned pagination.nextCursor as cursor to fetch the next page. Accepts the same window/lens params as queryMetric, plus key to drill a categorical metric to ONE breakdown row (e.g. topics?key=Billing returns the conversations in that one category). Use this (the metric-anchored drill) when you want the exact conversations behind a registry tile’s number. It differs from two siblings that return the same PaginatedConversationListItem shape: listConversations is the general searchable/filterable history (full-text q, sentiment); listTopicConversations is the per-agent topic-cluster drill (this endpoint’s ?key= is the registry-wide categorical equivalent).

GET

metrics

{id}

calls

Error

A valid request URL is required to generate request examples

{
  "success": true,
  "data": [
    {
      "id": "conv_9d2f01",
      "agentId": "agt_4f9c2b7e10a24d51",
      "channel": "voice",
      "startedAt": "2026-07-01T15:12:00.000Z",
      "durationS": 210,
      "resolution": "transferred",
      "language": "en",
      "outcome": "transferred",
      "goalCompleted": false,
      "summary": "Caller needed a manager for a billing dispute; transferred.",
      "primaryTopic": "Billing",
      "sentiment": "negative"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 50,
    "totalPages": 3,
    "nextCursor": "eyJjcmVhdGVkQXQiOiIyMDI2LTA3LTAxIn0"
  }
}

{
  "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. Unknown ids → 404.

Query Parameters

cursor

string

Opaque keyset cursor from the previous page's pagination.nextCursor.

limit

integer

default:20

Page size — how many items to return per page (1–100). Defaults to 20.

Required range: 1 <= x <= 100

from

string<date-time>

Window start (RFC3339, inclusive) — same window as the metric number.

string<date-time>

Window end (RFC3339, exclusive).

string

IANA timezone used to bound the window (default UTC).

channel

enum<string>

Restrict to one channel.

Available options:

voice,

chat,

sms

agent

string

Restrict to one agent id (AND-ed with queue).

queue

string

Restrict to one queue id (AND-ed with agent).

key

string

Categorical metrics only: drill to one breakdown row by its key (e.g. a topic category). Ignored by non-categorical metrics.

Response

Paginated conversation rows behind the metric.

success

boolean

required

data

object[]

required

Show child attributes

pagination

object

required

Show child attributes

message

string

errors

object[]

Show child attributes

Query one metric over a filter window List saved dashboards

Using the API

Endpoints

The conversations behind a metric number (drill-down)

Authorizations

Path Parameters

Query Parameters

Response