Skip to main content
GET
Error

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.

Query Parameters

from
string<date-time>

Window start (RFC3339, inclusive). Defaults to the last 30 days.

to
string<date-time>

Window end (RFC3339, exclusive). Defaults to now.

channel
enum<string>

Restrict to one channel. Omit for all.

Available options:
voice,
chat,
sms
avgTicketUsd
number

Org-level avg ticket in dollars (drives recoveredRevenueUsd).

avgTicketCents
integer

Org-level avg ticket in integer cents; takes precedence over avgTicketUsd.

Response

The org-wide reporting overview.

success
boolean
required
data
object
required

The org-wide reporting overview (GET /analytics/overview) — the fleet KPI strip rolled across EVERY agent.

message
string
errors
object[]