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
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.
Scopes
analytics:read
Read the Observe history list, per-agent analytics (the answer-rate summary), the raw knowledge-gap list, and the metric catalog + per-metric queries + metric drill-downs.
Path Parameters
id
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).
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
tz
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
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Flowyte","description":"Build AI voice and chat agents with an API-first platform.","colors":{"primary":"#6366F1","light":"#818CF8","dark":"#4F46E5"},"favicon":"https://mintcdn.com/flowyte/fmtYwMfV10g-ZMSz/favicon.png?fit=max\u0026auto=format\u0026n=fmtYwMfV10g-ZMSz\u0026q=85\u0026s=528cc7713e1da3bf15ac1ac62b9bc226","navbar":{"primary":{"type":"button","label":"Dashboard","href":"https://builder.flowyte.com"}},"footer":{"socials":{"website":"https://flowyte.com"}},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"flowyte","hasAudioNarration":false,"actualSubdomain":"flowyte","customDomains":["docs.flowyte.com"],"gitSource":{"type":"github","owner":"boarderking01","repo":"flowyte","deployBranch":"main","contentDirectory":"docs-site","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ac1773743a63d1170d90c4a","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"API Reference","count":284},{"language":"default","tag":"Endpoints","count":283},{"language":"default","tag":"Integrations","count":48},{"language":"default","tag":"Documentation","count":46},{"language":"default","tag":"Outbound","count":35},{"language":"default","tag":"Observe","count":28},{"language":"default","tag":"Numbers","count":21},{"language":"default","tag":"Escalation","count":20},{"language":"default","tag":"SMS","count":19},{"language":"default","tag":"Agents","count":16}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"site-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[]}
{"page":{"pagePath":"api-reference/observe/query-one-metric-over-a-filter-window","slug":"/api-reference/observe/query-one-metric-over-a-filter-window","pageMetadata":{"title":"Query one metric over a filter window","description":"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).\nFilters (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).\n","deprecated":null,"version":null,"openapi":"/openapi.yaml get /metrics/{id}","href":"/api-reference/observe/query-one-metric-over-a-filter-window","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Compute a single metric over a time window and a set of filter lenses, returning \", _jsx(_components.code, {\n children: \"{ series[], total, delta, n, unit, format }\"\n }), \" (plus a \", _jsx(_components.code, {\n children: \"breakdown[]\"\n }), \" for non-scalar metrics). \", _jsx(_components.code, {\n children: \"total\"\n }), \" is the scalar value for count/ratio/avg metrics and \", _jsx(_components.code, {\n children: \"null\"\n }), \" for distribution/percentile metrics (whose per-slice numbers live in \", _jsx(_components.code, {\n children: \"breakdown[]\"\n }), \"). \", _jsx(_components.code, {\n children: \"n\"\n }), \" is the honest sample count behind the number — a client should refuse to over-claim below a metric’s minimum-n. \", _jsx(_components.code, {\n children: \"series[]\"\n }), \" is the tz-aware per-bucket trend (empty for point-in-time backlog metrics).\\nFilters (all optional): \", _jsx(_components.code, {\n children: \"from\"\n }), \"/\", _jsx(_components.code, {\n children: \"to\"\n }), \" bound the window as a half-open \", _jsx(_components.code, {\n children: \"[from, to)\"\n }), \" range (RFC3339); \", _jsx(_components.code, {\n children: \"tz\"\n }), \" is the IANA timezone used to bucket the series (default UTC), which fixes day-boundary drift; \", _jsx(_components.code, {\n children: \"bucket\"\n }), \" sets the series granularity (day|week|month|hour, default day); \", _jsx(_components.code, {\n children: \"channel\"\n }), \" restricts to one channel; \", _jsx(_components.code, {\n children: \"agent\"\n }), \" and \", _jsx(_components.code, {\n children: \"queue\"\n }), \" are INDEPENDENT lenses (both may be set — they AND together, one narrowing to a single agent, the other to a single queue); \", _jsx(_components.code, {\n children: \"minN\"\n }), \" overrides the metric’s low-volume suppression floor. Applying a lens the metric does not declare (see the catalog’s \", _jsx(_components.code, {\n children: \"dimensions\"\n }), \") is a 400. \", _jsx(_components.code, {\n children: \"compare=true\"\n }), \" additionally computes \", _jsx(_components.code, {\n children: \"delta\"\n }), \" = current minus the immediately preceding equal-length window (scalar metrics with a bounded window only; otherwise \", _jsx(_components.code, {\n children: \"delta\"\n }), \" is null).\"]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Query one metric over a filter window","description":"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).\nFilters (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).\n","deprecated":null,"version":null,"openapi":"/openapi.yaml get /metrics/{id}","href":"/api-reference/observe/query-one-metric-over-a-filter-window","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"queryMetric","summary":"Query one metric over a filter window","description":"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).\nFilters (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).\n","tags":["Observe"],"security":["86e74d86-987d-42c0-b387-25e58fc7ccba"],"parameters":["047e66e7-2cb6-4754-8124-4e2542df3a4f","ac6fa83b-d568-4fbf-9143-26d193e015e1","3f46bfdd-1abd-4dc2-a866-48465cefd6f2","53dd6ba8-d2c8-4160-aca9-2b847d406337","36570cf8-d5b5-4a98-ad41-c3e3e285240e","cd55d7a0-bbf9-44fb-9e8a-29e2cd2c94b4","516a710c-78d6-41f9-a499-f7e40a547ed6","6d8cff2b-eaee-4110-8d7f-62135f9491d6","591c1564-d78d-4ad2-9921-6bac52b34999"],"responses":{"200":"1decd3ee-832a-47d4-8dab-2436e58e1f99","400":"1b240449-b8d8-4e78-b1eb-1f6170d55316","401":"240d85db-45b0-4e8d-a7f0-b58ef4395417","403":"75bbcc92-b4a4-43c4-9b8a-06b1c56c42af","404":"58520f99-0201-4edc-8a11-abcd67c7e883"},"method":"get","type":"path","servers":["8ecf0013-b6bd-4db1-b20a-722d17e47fa8"],"path":"/metrics/{id}","baseUrlOptions":["/api/v1"],"title":"Query one metric over a filter window","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"047e66e7-2cb6-4754-8124-4e2542df3a4f":{"name":"from","in":"query","description":"Window start (RFC3339); window is half-open [from, to).","example":"2026-06-01T00:00:00.000Z","schema":{"type":"string","format":"date-time","description":"Window start (RFC3339); window is half-open [from, to).","uniqueKey":"","typeLabel":"string\u003cdate-time>"}},"ac6fa83b-d568-4fbf-9143-26d193e015e1":{"name":"to","in":"query","description":"Window end (RFC3339, exclusive).","example":"2026-07-01T00:00:00.000Z","schema":{"type":"string","format":"date-time","description":"Window end (RFC3339, exclusive).","uniqueKey":"","typeLabel":"string\u003cdate-time>"}},"3f46bfdd-1abd-4dc2-a866-48465cefd6f2":{"name":"compare","in":"query","description":"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.","example":"prev","schema":{"type":"string","enum":["prev","lastweek","true"],"description":"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.","uniqueKey":"","typeLabel":"enum\u003cstring>"}},"53dd6ba8-d2c8-4160-aca9-2b847d406337":{"name":"tz","in":"query","description":"IANA timezone for series bucketing (default UTC). Fixes day-boundary drift.","example":"America/New_York","schema":{"type":"string","description":"IANA timezone for series bucketing (default UTC). Fixes day-boundary drift.","uniqueKey":"","typeLabel":"string"}},"36570cf8-d5b5-4a98-ad41-c3e3e285240e":{"name":"bucket","in":"query","description":"Series granularity (default day).","example":"day","schema":{"type":"string","enum":["day","week","month","hour"],"description":"Series granularity (default day).","uniqueKey":"","typeLabel":"enum\u003cstring>"}},"cd55d7a0-bbf9-44fb-9e8a-29e2cd2c94b4":{"name":"channel","in":"query","description":"Restrict to one channel.","example":"voice","schema":{"type":"string","enum":["voice","chat","sms"],"description":"Restrict to one channel.","uniqueKey":"","typeLabel":"enum\u003cstring>"}},"516a710c-78d6-41f9-a499-f7e40a547ed6":{"name":"agent","in":"query","description":"Restrict to one agent id. Independent of queue (they AND together).","example":"agt_4f9c2b7e10a24d51","schema":{"type":"string","description":"Restrict to one agent id. Independent of queue (they AND together).","uniqueKey":"","typeLabel":"string"}},"6d8cff2b-eaee-4110-8d7f-62135f9491d6":{"name":"queue","in":"query","description":"Restrict to one queue id. Independent of agent (they AND together).","example":"queue_sales","schema":{"type":"string","description":"Restrict to one queue id. Independent of agent (they AND together).","uniqueKey":"","typeLabel":"string"}},"591c1564-d78d-4ad2-9921-6bac52b34999":{"name":"minN","in":"query","description":"Override the metric low-volume suppression floor.","example":20,"schema":{"type":"integer","minimum":0,"description":"Override the metric low-volume suppression floor.","uniqueKey":"","typeLabel":"integer"}},"f23124b8-8dcc-4eb5-a511-8cda559d396f":{"name":"id","in":"path","required":true,"description":"A metric id from the catalog (e.g. `containment`). Unknown ids → 404.","example":"containment","schema":{"type":"string","isRequired":true,"description":"A metric id from the catalog (e.g. `containment`). Unknown ids → 404.","uniqueKey":"","typeLabel":"string"}}},"responses":{"1decd3ee-832a-47d4-8dab-2436e58e1f99":{"description":"The compiled metric result.","content":{"application/json":{"schema":{"type":"object","required":["data","success"],"properties":{"success":{"type":"boolean","isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"data":{"type":"object","description":"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.\n","required":["id","unit","format","n","series"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"data.id","typeLabel":"string"},"unit":{"type":"string","isRequired":true,"uniqueKey":"data.unit","typeLabel":"string"},"format":{"type":"string","isRequired":true,"uniqueKey":"data.format","typeLabel":"string"},"n":{"type":"integer","description":"Sample count (the denominator) behind the number.","isRequired":true,"uniqueKey":"data.n","typeLabel":"integer"},"series":{"type":"array","items":{"type":"object","description":"One point of a metric trend. `group` names the sub-series (distribution bucket name, or latency language) and is empty for a plain scalar series.","required":["n"],"properties":{"n":{"type":"integer","isRequired":true,"uniqueKey":"data.series.items.[INDEX].n","typeLabel":"integer"},"bucket":{"type":"string","format":"date-time","description":"The tz-aware period start (RFC3339).","uniqueKey":"data.series.items.[INDEX].bucket","typeLabel":"string\u003cdate-time>"},"group":{"type":"string","uniqueKey":"data.series.items.[INDEX].group","typeLabel":"string"},"value":{"oneOf":[{"type":"number","uniqueKey":"data.series.items.[INDEX].value.oneOf.0","typeLabel":"number"},{"type":"null","uniqueKey":"data.series.items.[INDEX].value.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.series.items.[INDEX].value","typeLabel":"number | null"}},"uniqueKey":"data.series.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"data.series","typeLabel":"object[]"},"total":{"oneOf":[{"type":"number","description":"The scalar value; null for distribution/percentile metrics.","uniqueKey":"data.total.oneOf.0","typeLabel":"number"},{"type":"null","description":"The scalar value; null for distribution/percentile metrics.","uniqueKey":"data.total.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.total","typeLabel":"number | null"},"delta":{"oneOf":[{"type":"number","description":"total minus the previous equal-length window; null unless ?compare= on a scalar metric.","uniqueKey":"data.delta.oneOf.0","typeLabel":"number"},{"type":"null","description":"total minus the previous equal-length window; null unless ?compare= on a scalar metric.","uniqueKey":"data.delta.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.delta","typeLabel":"number | null"},"unscored":{"type":"integer","description":"Honesty disclosure: how many counted conversations are NOT YET analyzed (pending) for a metric that scores un-analyzed calls as failures (goal_completion) or drops them from an average (sentiment_avg). Present only for metrics with an unscored notion, so a client can banner \"N pending analysis\" rather than over-claiming. Distribution metrics (sentiment mix) instead carry this as an `unscored` breakdown row.\n","uniqueKey":"data.unscored","typeLabel":"integer"},"breakdown":{"type":"array","description":"Non-scalar detail: distribution bucket counts (key = bucket name), per-language percentile rows (key = language), or categorical/topic rows (key = category, value = volume, delta = trend vs the prior window). Absent for plain scalar metrics.","items":{"type":"object","description":"One slice of a non-scalar total: a distribution bucket, a percentile language/stage row, or a categorical/topic row.","required":["key","n"],"properties":{"key":{"type":"string","description":"Bucket name (distribution), language (per-language latency), pipeline stage (latency_by_stage), or category (categorical/topics).","isRequired":true,"uniqueKey":"data.breakdown.items.[INDEX].key","typeLabel":"string"},"n":{"type":"integer","isRequired":true,"uniqueKey":"data.breakdown.items.[INDEX].n","typeLabel":"integer"},"value":{"oneOf":[{"type":"number","uniqueKey":"data.breakdown.items.[INDEX].value.oneOf.0","typeLabel":"number"},{"type":"null","uniqueKey":"data.breakdown.items.[INDEX].value.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.breakdown.items.[INDEX].value","typeLabel":"number | null"},"delta":{"oneOf":[{"type":"number","description":"Categorical only: trend vs the immediately preceding equal-length window (value minus the prior window volume). Absent unless the query carried a bounded window.","uniqueKey":"data.breakdown.items.[INDEX].delta.oneOf.0","typeLabel":"number"},{"type":"null","description":"Categorical only: trend vs the immediately preceding equal-length window (value minus the prior window volume). Absent unless the query carried a bounded window.","uniqueKey":"data.breakdown.items.[INDEX].delta.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.breakdown.items.[INDEX].delta","typeLabel":"number | null"},"valueP95":{"oneOf":[{"type":"number","description":"latency_by_stage only: the p95 (tail) for the stage, alongside `value` which carries the p50. Absent for every other breakdown kind.","uniqueKey":"data.breakdown.items.[INDEX].valueP95.oneOf.0","typeLabel":"number"},{"type":"null","description":"latency_by_stage only: the p95 (tail) for the stage, alongside `value` which carries the p50. Absent for every other breakdown kind.","uniqueKey":"data.breakdown.items.[INDEX].valueP95.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.breakdown.items.[INDEX].valueP95","typeLabel":"number | null"},"extras":{"type":"object","description":"calls_by_number only: the per-tracking-number marketing-attribution aggregate pack a CategoricalExtras metric attaches to each breakdown row alongside the headline call count. All counts are over the current window. Absent for every other breakdown kind.\n","required":["uniqCallers","newCallers","leads30","leads60","leads90","junk","goalsMet"],"properties":{"uniqCallers":{"type":"integer","description":"Distinct caller numbers in the window.","isRequired":true,"uniqueKey":"data.breakdown.items.[INDEX].extras.uniqCallers","typeLabel":"integer"},"newCallers":{"type":"integer","description":"Distinct callers whose first-ever call to this org landed in the window.","isRequired":true,"uniqueKey":"data.breakdown.items.[INDEX].extras.newCallers","typeLabel":"integer"},"leads30":{"type":"integer","description":"Calls that lasted at least 30 seconds (and ≥10s).","isRequired":true,"uniqueKey":"data.breakdown.items.[INDEX].extras.leads30","typeLabel":"integer"},"leads60":{"type":"integer","description":"Calls that lasted at least 60 seconds (and ≥10s).","isRequired":true,"uniqueKey":"data.breakdown.items.[INDEX].extras.leads60","typeLabel":"integer"},"leads90":{"type":"integer","description":"Calls that lasted at least 90 seconds (and ≥10s).","isRequired":true,"uniqueKey":"data.breakdown.items.[INDEX].extras.leads90","typeLabel":"integer"},"junk":{"type":"integer","description":"Calls under 10 seconds.","isRequired":true,"uniqueKey":"data.breakdown.items.[INDEX].extras.junk","typeLabel":"integer"},"goalsMet":{"type":"integer","description":"Calls where the AI reached the configured goal (call_summaries.goal_completed).","isRequired":true,"uniqueKey":"data.breakdown.items.[INDEX].extras.goalsMet","typeLabel":"integer"},"avgDurationS":{"oneOf":[{"type":"number","description":"Average call duration in seconds (null when the number has no counted calls).","uniqueKey":"data.breakdown.items.[INDEX].extras.avgDurationS.oneOf.0","typeLabel":"number"},{"type":"null","description":"Average call duration in seconds (null when the number has no counted calls).","uniqueKey":"data.breakdown.items.[INDEX].extras.avgDurationS.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.breakdown.items.[INDEX].extras.avgDurationS","typeLabel":"number | null"},"trend":{"type":"array","items":{"type":"integer","uniqueKey":"data.breakdown.items.[INDEX].extras.trend.items.[INDEX]","typeLabel":"integer"},"description":"Per-day call counts over the window (chronological, dense, UTC days). Present for the top-8 numbers by volume only.","uniqueKey":"data.breakdown.items.[INDEX].extras.trend","typeLabel":"integer[]"}},"uniqueKey":"data.breakdown.items.[INDEX].extras","typeLabel":"object"}},"uniqueKey":"data.breakdown.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.breakdown","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"data","typeLabel":"object"},"message":{"type":"string","uniqueKey":"message","typeLabel":"string"},"errors":{"type":"array","items":{"type":"object","required":["field","message"],"properties":{"field":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"example":{"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}]}},"examples":{"Example":{"title":"Example","value":{"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}]}}}},"exampleType":"examples"}},"exampleType":"examples"},"1b240449-b8d8-4e78-b1eb-1f6170d55316":{"description":"Validation failure (errors[] populated on the envelope).","content":{"application/problem+json":{"schema":{"description":"RFC 9457 problem+json.","type":"object","properties":{"type":{"type":"string","format":"uri","default":"about:blank","uniqueKey":"type","typeLabel":"string\u003curi>"},"title":{"type":"string","uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","uniqueKey":"status","typeLabel":"integer"},"detail":{"type":"string","uniqueKey":"detail","typeLabel":"string"},"instance":{"type":"string","uniqueKey":"instance","typeLabel":"string"},"code":{"type":"string","uniqueKey":"code","typeLabel":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","uniqueKey":"errors.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"type":"about:blank","title":"\u003cstring>","status":123,"detail":"\u003cstring>","instance":"\u003cstring>","code":"\u003cstring>","errors":[{"field":"\u003cstring>","message":"\u003cstring>"}]}}},"exampleType":"generated"},"application/json":{"schema":{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"message":{"type":"string","uniqueKey":"message","typeLabel":"string"},"errors":{"type":"array","items":{"type":"object","required":["field","message"],"properties":{"field":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"},"data":{"oneOf":[{"type":"object","uniqueKey":"data.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"data.oneOf.1","typeLabel":"null"}],"uniqueKey":"data","typeLabel":"object | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":true,"message":"\u003cstring>","errors":[{"field":"\u003cstring>","message":"\u003cstring>"}],"data":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"240d85db-45b0-4e8d-a7f0-b58ef4395417":{"description":"Missing or invalid API key.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/problem+json":{"schema":{"description":"RFC 9457 problem+json.","type":"object","properties":{"type":{"type":"string","format":"uri","default":"about:blank","uniqueKey":"type","typeLabel":"string\u003curi>"},"title":{"type":"string","uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","uniqueKey":"status","typeLabel":"integer"},"detail":{"type":"string","uniqueKey":"detail","typeLabel":"string"},"instance":{"type":"string","uniqueKey":"instance","typeLabel":"string"},"code":{"type":"string","uniqueKey":"code","typeLabel":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","uniqueKey":"errors.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"type":"about:blank","title":"\u003cstring>","status":123,"detail":"\u003cstring>","instance":"\u003cstring>","code":"\u003cstring>","errors":[{"field":"\u003cstring>","message":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"75bbcc92-b4a4-43c4-9b8a-06b1c56c42af":{"description":"Org mismatch / RLS / insufficient scope / origin not allowed.","content":{"application/problem+json":{"schema":{"description":"RFC 9457 problem+json.","type":"object","properties":{"type":{"type":"string","format":"uri","default":"about:blank","uniqueKey":"type","typeLabel":"string\u003curi>"},"title":{"type":"string","uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","uniqueKey":"status","typeLabel":"integer"},"detail":{"type":"string","uniqueKey":"detail","typeLabel":"string"},"instance":{"type":"string","uniqueKey":"instance","typeLabel":"string"},"code":{"type":"string","uniqueKey":"code","typeLabel":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","uniqueKey":"errors.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"type":"about:blank","title":"\u003cstring>","status":123,"detail":"\u003cstring>","instance":"\u003cstring>","code":"\u003cstring>","errors":[{"field":"\u003cstring>","message":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"58520f99-0201-4edc-8a11-abcd67c7e883":{"description":"Resource not found in org scope.","content":{"application/problem+json":{"schema":{"description":"RFC 9457 problem+json.","type":"object","properties":{"type":{"type":"string","format":"uri","default":"about:blank","uniqueKey":"type","typeLabel":"string\u003curi>"},"title":{"type":"string","uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","uniqueKey":"status","typeLabel":"integer"},"detail":{"type":"string","uniqueKey":"detail","typeLabel":"string"},"instance":{"type":"string","uniqueKey":"instance","typeLabel":"string"},"code":{"type":"string","uniqueKey":"code","typeLabel":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","uniqueKey":"errors.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"type":"about:blank","title":"\u003cstring>","status":123,"detail":"\u003cstring>","instance":"\u003cstring>","code":"\u003cstring>","errors":[{"field":"\u003cstring>","message":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"86e74d86-987d-42c0-b387-25e58fc7ccba":{"apiKey":{"type":"oauth2","description":"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.\n","flows":{"clientCredentials":{"tokenUrl":"/api/v1/api-keys","scopes":{"agents:read":"Read agents.","agents:write":"Create/update/delete agents, publish, rollback.","knowledge:read":"Read knowledge sources \u0026 preview.","knowledge:write":"Add/remove knowledge sources, uploads.","skills:read":"Read skills \u0026 skill-types.","skills:write":"Create/update/delete skills.","playbooks:read":"Read playbooks \u0026 graphs.","playbooks:write":"Create/update/delete playbooks \u0026 graphs.","guardrails:read":"Read guardrail policies \u0026 caller-verification.","guardrails:write":"Update guardrail policies \u0026 caller-verification.","numbers:read":"Read phone numbers / search availability.","numbers:write":"Purchase / assign / release numbers.","sms:read":"Read the org's SMS (10DLC) registration status and numbers, SMS contacts, and download any text-message attachment by id (getSMSMedia) — pictures, videos and files (such as a PDF) sent or received by text.","sms:write":"Save/submit the 10DLC registration, toggle numbers for SMS, record or revoke a contact's SMS consent, and upload pictures and short videos to send by text.","sms:send":"Send outbound text messages from the org's SMS-enabled numbers (consent, opt-out and quiet hours are enforced server-side), with pictures or short videos attached — including any text-message attachment of the workspace whose id the caller knows (an upload, or a picture a customer sent).","outbound:read":"Read outbound contact lists and campaigns.","outbound:write":"Create/import contact lists, create/launch/pause/resume/cancel outbound campaigns, and enqueue single outbound calls.","integrations:read":"Read connected native integrations (status only — never tokens).","integrations:write":"Discover schemas, set data scoping, and disconnect a connection.","integrations:connect":"Connect a data source (submit credentials / begin OAuth) — a SEPARATE, higher-privilege scope because connecting INGESTS credentials and opens a new egress path; a discover/scope/author key need not carry it.","records:read":"Read the pre-synced Caller Context Store records and object-type field registry.","records:write":"Upsert / delete / bulk-import / purge caller-context records and edit type metadata.","calls:read":"Read conversations, receipts, transcripts, analytics.","analytics:read":"Read the Observe history list, per-agent analytics (the answer-rate summary), the raw knowledge-gap list, and the metric catalog + per-metric queries + metric drill-downs.","analytics:write":"Curate knowledge gaps (dismiss / mark in-progress). [M4 — reserved]","dashboards:read":"List and read saved Observe reporting dashboards.","dashboards:write":"Create, update (full-document replace), and delete Observe reporting dashboards.","reports:read":"List and read Observe scheduled reports (report schedules).","reports:write":"Create, update, and delete Observe scheduled reports (a delete stops a recurring digest).","billing:read":"Read plans, wallet, usage.","audit:read":"Read API/key activity logs.","webhooks:write":"Manage webhook endpoints.","keys:write":"Manage secret API keys.","chat:read":"Read chat sessions \u0026 messages.","chat:write":"Create chat sessions \u0026 send messages (server-side).","widgets:read":"Read widget config \u0026 embed snippet.","widgets:write":"Update widget config.","pubkeys:read":"Read publishable keys.","pubkeys:write":"Manage publishable keys.","phone:read":"Read Flowyte Phone config — settings, ring targets/queues + rosters, contacts, block-list, own presence.","phone:write":"Update Flowyte Phone config — settings, ring targets/queues + members, contacts, block-list.","presence:write":"Set your own softphone presence (available/away/dnd/…).","team:read":"Read the team — softphone seats and the team presence roster.","team:write":"Manage softphone seats — invite, update, and deactivate team members.","escalation_destinations:read":"Read external-agent (AI Harness) escalation destinations.","escalation_destinations:write":"Create, update, delete, and rotate the signing secret of escalation destinations.","escalation_policies:read":"Read an agent's escalation routing policy. [ — reserved]","escalation_policies:write":"Update an agent's escalation routing policy. [ — reserved]","escalations:read":"Read escalation sessions and their message history (connector). [ — reserved]","escalations:claim":"Claim an escalation session and extend its lease (connector). [ — reserved]","escalations:respond":"Post messages into a claimed escalation session (connector). [ — reserved]","escalations:resolve":"Resolve, return, or request human takeover of an escalation (connector). [ — reserved]","escalations:initiate":"Start a NEW outbound SMS conversation with a customer (connector). Deliberately separate from escalations:respond — the other scopes work a conversation the platform handed over; this one texts a person who never contacted you on that thread. Also requires the org to be enabled for harness-initiated conversations."}}},"scopes":["analytics:read"]}}},"servers":{"8ecf0013-b6bd-4db1-b20a-722d17e47fa8":{"url":"/api/v1","description":"Flowyte control-plane (versioned URI; additive in v1)."}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"oauth2","description":"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.\n","flows":{"clientCredentials":{"tokenUrl":"/api/v1/api-keys","scopes":{"agents:read":"Read agents.","agents:write":"Create/update/delete agents, publish, rollback.","knowledge:read":"Read knowledge sources \u0026 preview.","knowledge:write":"Add/remove knowledge sources, uploads.","skills:read":"Read skills \u0026 skill-types.","skills:write":"Create/update/delete skills.","playbooks:read":"Read playbooks \u0026 graphs.","playbooks:write":"Create/update/delete playbooks \u0026 graphs.","guardrails:read":"Read guardrail policies \u0026 caller-verification.","guardrails:write":"Update guardrail policies \u0026 caller-verification.","numbers:read":"Read phone numbers / search availability.","numbers:write":"Purchase / assign / release numbers.","sms:read":"Read the org's SMS (10DLC) registration status and numbers, SMS contacts, and download any text-message attachment by id (getSMSMedia) — pictures, videos and files (such as a PDF) sent or received by text.","sms:write":"Save/submit the 10DLC registration, toggle numbers for SMS, record or revoke a contact's SMS consent, and upload pictures and short videos to send by text.","sms:send":"Send outbound text messages from the org's SMS-enabled numbers (consent, opt-out and quiet hours are enforced server-side), with pictures or short videos attached — including any text-message attachment of the workspace whose id the caller knows (an upload, or a picture a customer sent).","outbound:read":"Read outbound contact lists and campaigns.","outbound:write":"Create/import contact lists, create/launch/pause/resume/cancel outbound campaigns, and enqueue single outbound calls.","integrations:read":"Read connected native integrations (status only — never tokens).","integrations:write":"Discover schemas, set data scoping, and disconnect a connection.","integrations:connect":"Connect a data source (submit credentials / begin OAuth) — a SEPARATE, higher-privilege scope because connecting INGESTS credentials and opens a new egress path; a discover/scope/author key need not carry it.","records:read":"Read the pre-synced Caller Context Store records and object-type field registry.","records:write":"Upsert / delete / bulk-import / purge caller-context records and edit type metadata.","calls:read":"Read conversations, receipts, transcripts, analytics.","analytics:read":"Read the Observe history list, per-agent analytics (the answer-rate summary), the raw knowledge-gap list, and the metric catalog + per-metric queries + metric drill-downs.","analytics:write":"Curate knowledge gaps (dismiss / mark in-progress). [M4 — reserved]","dashboards:read":"List and read saved Observe reporting dashboards.","dashboards:write":"Create, update (full-document replace), and delete Observe reporting dashboards.","reports:read":"List and read Observe scheduled reports (report schedules).","reports:write":"Create, update, and delete Observe scheduled reports (a delete stops a recurring digest).","billing:read":"Read plans, wallet, usage.","audit:read":"Read API/key activity logs.","webhooks:write":"Manage webhook endpoints.","keys:write":"Manage secret API keys.","chat:read":"Read chat sessions \u0026 messages.","chat:write":"Create chat sessions \u0026 send messages (server-side).","widgets:read":"Read widget config \u0026 embed snippet.","widgets:write":"Update widget config.","pubkeys:read":"Read publishable keys.","pubkeys:write":"Manage publishable keys.","phone:read":"Read Flowyte Phone config — settings, ring targets/queues + rosters, contacts, block-list, own presence.","phone:write":"Update Flowyte Phone config — settings, ring targets/queues + members, contacts, block-list.","presence:write":"Set your own softphone presence (available/away/dnd/…).","team:read":"Read the team — softphone seats and the team presence roster.","team:write":"Manage softphone seats — invite, update, and deactivate team members.","escalation_destinations:read":"Read external-agent (AI Harness) escalation destinations.","escalation_destinations:write":"Create, update, delete, and rotate the signing secret of escalation destinations.","escalation_policies:read":"Read an agent's escalation routing policy. [ — reserved]","escalation_policies:write":"Update an agent's escalation routing policy. [ — reserved]","escalations:read":"Read escalation sessions and their message history (connector). [ — reserved]","escalations:claim":"Claim an escalation session and extend its lease (connector). [ — reserved]","escalations:respond":"Post messages into a claimed escalation session (connector). [ — reserved]","escalations:resolve":"Resolve, return, or request human takeover of an escalation (connector). [ — reserved]","escalations:initiate":"Start a NEW outbound SMS conversation with a customer (connector). Deliberately separate from escalations:respond — the other scopes work a conversation the platform handed over; this one texts a person who never contacted you on that thread. Also requires the org to be enabled for harness-initiated conversations."}}},"scopes":["analytics:read"]},"schema":{"title":"OAuth2 Auth","type":"string","isRequired":true,"description":"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.\n","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"apiKey","name":"Authorization"}],"title":"apiKey"}]},"originalFileLocation":"openapi.yaml"},"subdomain":"flowyte","siteName":"Flowyte","title":"Query one metric over a filter window - Flowyte","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-03T21:44:34.561Z","originalFileLocation":"api-reference/observe/query-one-metric-over-a-filter-window.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"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\u0026#x27;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\u0026#x27;s low-volume suppression floor. Applying a lens the metric does not declare (see the catalog\u0026#x27;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).\">\u003cmeta data-mint-head name=\"application-name\" content=\"Flowyte\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/flowyte/Z_GhxvXdfHoIuVAX/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/flowyte/Z_GhxvXdfHoIuVAX/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/flowyte/Z_GhxvXdfHoIuVAX/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/flowyte/Z_GhxvXdfHoIuVAX/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/flowyte/Z_GhxvXdfHoIuVAX/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/flowyte/Z_GhxvXdfHoIuVAX/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/flowyte/Z_GhxvXdfHoIuVAX/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/flowyte/Z_GhxvXdfHoIuVAX/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/flowyte/Z_GhxvXdfHoIuVAX/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Query one metric over a filter window - Flowyte\">\u003cmeta data-mint-head property=\"og:description\" content=\"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\u0026#x27;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\u0026#x27;s low-volume suppression floor. Applying a lens the metric does not declare (see the catalog\u0026#x27;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).\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Flowyte\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.flowyte.com/api-reference/observe/query-one-metric-over-a-filter-window\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://flowyte.mintlify.site/_mintlify/api/og/v2?division=Observe\u0026amp;title=Query+one+metric+over+a+filter+window\u0026amp;description=Compute+a+single+metric+over+a+time+window+and+a+set+of+filter+lenses%2C+returning+%60%7B+series%5B%5D%2C+total%2C+delta%2C+n%2C+unit%2C+format+%7D%60+%28plus+a+%60breakdown%5B%5D%60+for+non-sca\u0026amp;theme=0a3a852175ddc8e5bfd2cfca\u0026amp;signature=836aa3315e071944076ac60d352c6a214fa9e742339eddf60e8187b51c5dc09c\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Query one metric over a filter window - Flowyte\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"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\u0026#x27;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\u0026#x27;s low-volume suppression floor. Applying a lens the metric does not declare (see the catalog\u0026#x27;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).\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://flowyte.mintlify.site/_mintlify/api/og/v2?division=Observe\u0026amp;title=Query+one+metric+over+a+filter+window\u0026amp;description=Compute+a+single+metric+over+a+time+window+and+a+set+of+filter+lenses%2C+returning+%60%7B+series%5B%5D%2C+total%2C+delta%2C+n%2C+unit%2C+format+%7D%60+%28plus+a+%60breakdown%5B%5D%60+for+non-sca\u0026amp;theme=0a3a852175ddc8e5bfd2cfca\u0026amp;signature=836aa3315e071944076ac60d352c6a214fa9e742339eddf60e8187b51c5dc09c\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/flowyte/Z_GhxvXdfHoIuVAX/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Flowyte\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#6366F1\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.flowyte.com/api-reference/observe/query-one-metric-over-a-filter-window\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/observe/query-one-metric-over-a-filter-window.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.flowyte.com/#organization\",\"name\":\"Flowyte\",\"url\":\"https://docs.flowyte.com\"},{\"@type\":\"WebSite\",\"@id\":\"https://docs.flowyte.com#website\",\"name\":\"Flowyte\",\"url\":\"https://docs.flowyte.com\",\"publisher\":{\"@id\":\"https://docs.flowyte.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.flowyte.com/api-reference/observe/query-one-metric-over-a-filter-window#webpage\",\"url\":\"https://docs.flowyte.com/api-reference/observe/query-one-metric-over-a-filter-window\",\"name\":\"Query one metric over a filter window\",\"description\":\"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).\",\"dateModified\":\"2026-10-03T21:44:34.561Z\",\"isPartOf\":{\"@id\":\"https://docs.flowyte.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.flowyte.com/api-reference/observe/query-one-metric-over-a-filter-window#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.flowyte.com/api-reference/observe/query-one-metric-over-a-filter-window#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoints\",\"item\":\"https://docs.flowyte.com/api-reference/support/submit-a-support-request\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Observe\",\"item\":\"https://docs.flowyte.com/api-reference/observe/get-agent-analytics\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Query one metric over a filter window\",\"item\":\"https://docs.flowyte.com/api-reference/observe/query-one-metric-over-a-filter-window\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.flowyte.com/api-reference/observe/query-one-metric-over-a-filter-window#apireference\",\"headline\":\"Query one metric over a filter window\",\"name\":\"Query one metric over a filter window\",\"description\":\"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).\",\"url\":\"https://docs.flowyte.com/api-reference/observe/query-one-metric-over-a-filter-window\",\"mainEntityOfPage\":{\"@id\":\"https://docs.flowyte.com/api-reference/observe/query-one-metric-over-a-filter-window#webpage\"},\"dateModified\":\"2026-10-03T21:44:34.561Z\",\"publisher\":{\"@id\":\"https://docs.flowyte.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.flowyte.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Flowyte\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Flowyte\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/observe/query-one-metric-over-a-filter-window.md","siteName":"Flowyte","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":""}]},{"tab":"Solutions","pages":[{"title":"Solutions","href":"/solutions/answering-service"}]},{"tab":"API Reference","groups":[{"group":"Using the API","pages":[{"title":"Using the API","href":"/api-reference/introduction"}]},{"group":"Endpoints","pages":[{"group":"Support","pages":[{"title":"Submit a support request","deprecated":null,"version":null,"openapi":"/openapi.yaml post /support/requests","href":"/api-reference/support/submit-a-support-request"}]},{"group":"Agents","pages":[{"title":"List agents","deprecated":null,"version":null,"openapi":"/openapi.yaml get /agents","href":"/api-reference/agents/list-agents"},{"title":"Create an agent","deprecated":null,"version":null,"openapi":"/openapi.yaml post /agents","href":"/api-reference/agents/create-an-agent"},{"title":"Scaffold a draft agent","deprecated":null,"version":null,"openapi":"/openapi.yaml post /agents/scaffold","href":"/api-reference/agents/scaffold-a-draft-agent"},{"title":"Get an agent","deprecated":null,"version":null,"openapi":"/openapi.yaml get /agents/{id}","href":"/api-reference/agents/get-an-agent"},{"title":"Delete an agent","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /agents/{id}","href":"/api-reference/agents/delete-an-agent"},{"title":"Update an agent","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /agents/{id}","href":"/api-reference/agents/update-an-agent"},{"title":"Set the agent's voice","deprecated":null,"version":null,"openapi":"/openapi.yaml put /agents/{id}/voice","href":"/api-reference/agents/set-the-agents-voice"},{"title":"Publish an agent","deprecated":null,"version":null,"openapi":"/openapi.yaml post /agents/{id}/publish","href":"/api-reference/agents/publish-an-agent"},{"title":"Roll back to a previous version","deprecated":null,"version":null,"openapi":"/openapi.yaml post /agents/{id}/rollback","href":"/api-reference/agents/roll-back-to-a-previous-version"},{"title":"List agent versions","deprecated":null,"version":null,"openapi":"/openapi.yaml get /agents/{id}/versions","href":"/api-reference/agents/list-agent-versions"},{"title":"Compare a version with the draft","deprecated":null,"version":null,"openapi":"/openapi.yaml get /agents/{id}/versions/{versionId}/diff","href":"/api-reference/agents/compare-a-version-with-the-draft"},{"title":"Get the pre-publish report","deprecated":null,"version":null,"openapi":"/openapi.yaml get /agents/{id}/prepublish-report","href":"/api-reference/agents/get-the-pre-publish-report"},{"title":"Configure an agent with AI","deprecated":null,"version":null,"openapi":"/openapi.yaml post /agents/{id}/assist","href":"/api-reference/agents/configure-an-agent-with-ai"},{"title":"Account AI copilot","deprecated":null,"version":null,"openapi":"/openapi.yaml post /assist","href":"/api-reference/agents/account-ai-copilot"},{"title":"List AI copilot threads","deprecated":null,"version":null,"openapi":"/openapi.yaml get /assist/threads","href":"/api-reference/agents/list-ai-copilot-threads"},{"title":"Get an AI copilot thread","deprecated":null,"version":null,"openapi":"/openapi.yaml get /assist/threads/{threadId}","href":"/api-reference/agents/get-an-ai-copilot-thread"}]},{"group":"Skills","pages":[{"title":"List available skill types","deprecated":null,"version":null,"openapi":"/openapi.yaml get /skill-types","href":"/api-reference/skills/list-available-skill-types"},{"title":"List an agent's skills","deprecated":null,"version":null,"openapi":"/openapi.yaml get /agents/{agentId}/skills","href":"/api-reference/skills/list-an-agents-skills"},{"title":"Create a skill","deprecated":null,"version":null,"openapi":"/openapi.yaml post /agents/{agentId}/skills","href":"/api-reference/skills/create-a-skill"},{"title":"Get a skill","deprecated":null,"version":null,"openapi":"/openapi.yaml get /agents/{agentId}/skills/{id}","href":"/api-reference/skills/get-a-skill"},{"title":"Delete a skill","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /agents/{agentId}/skills/{id}","href":"/api-reference/skills/delete-a-skill"},{"title":"Update a skill","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /agents/{agentId}/skills/{id}","href":"/api-reference/skills/update-a-skill"},{"title":"Geocode a location roster","deprecated":null,"version":null,"openapi":"/openapi.yaml post /agents/{agentId}/geocode-roster","href":"/api-reference/skills/geocode-a-location-roster"}]},{"group":"Integrations","pages":[{"title":"Add an integration's actions as skills","deprecated":null,"version":null,"openapi":"/openapi.yaml post /agents/{agentId}/integrations/{kind}/provision","href":"/api-reference/integrations/add-an-integrations-actions-as-skills"},{"title":"Remove an integration's skills from an agent","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /agents/{agentId}/integrations/{kind}/provision","href":"/api-reference/integrations/remove-an-integrations-skills-from-an-agent"},{"title":"Map an integration's fields to a skill","deprecated":null,"version":null,"openapi":"/openapi.yaml post /agents/{agentId}/integrations/{kind}/bindings","href":"/api-reference/integrations/map-an-integrations-fields-to-a-skill"},{"title":"Auto-map a binding from a goal","deprecated":null,"version":null,"openapi":"/openapi.yaml post /agents/{agentId}/integrations/{kind}/bindings/auto","href":"/api-reference/integrations/auto-map-a-binding-from-a-goal"},{"title":"Freeze an MCP tool into a skill","deprecated":null,"version":null,"openapi":"/openapi.yaml post /agents/{agentId}/integrations/{kind}/mcp-skills","href":"/api-reference/integrations/freeze-an-mcp-tool-into-a-skill"},{"title":"Freeze one resolved Composio tool into a `composio` skill on the agent (Agent Bridge )","deprecated":null,"version":null,"openapi":"/openapi.yaml post /agents/{agentId}/integrations/{kind}/skills","href":"/api-reference/integrations/freeze-one-resolved-composio-tool-into-a-`composio`-skill-on-the-agent-agent-bridge-"},{"title":"Install a provider's preset skills","deprecated":null,"version":null,"openapi":"/openapi.yaml post /agents/{agentId}/integrations/{kind}/pack/install","href":"/api-reference/integrations/install-a-providers-preset-skills"},{"title":"List connected integrations","deprecated":null,"version":null,"openapi":"/openapi.yaml get /integrations","href":"/api-reference/integrations/list-connected-integrations"},{"title":"List the integration catalog","deprecated":null,"version":null,"openapi":"/openapi.yaml get /integrations/catalog","href":"/api-reference/integrations/list-the-integration-catalog"},{"title":"Connect an integration","deprecated":null,"version":null,"openapi":"/openapi.yaml post /integrations/{kind}/connect","href":"/api-reference/integrations/connect-an-integration"},{"title":"List a provider's connected accounts (Composio)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /integrations/{kind}/accounts","href":"/api-reference/integrations/list-a-providers-connected-accounts-composio"},{"title":"Claim a Shopify App Store install","deprecated":null,"version":null,"openapi":"/openapi.yaml post /integrations/{kind}/claim","href":"/api-reference/integrations/claim-a-shopify-app-store-install"},{"title":"List an integration's available actions","deprecated":null,"version":null,"openapi":"/openapi.yaml get /integrations/{kind}/actions","href":"/api-reference/integrations/list-an-integrations-available-actions"},{"title":"List a connected MCP endpoint's tools","deprecated":null,"version":null,"openapi":"/openapi.yaml get /integrations/{kind}/tools","href":"/api-reference/integrations/list-a-connected-mcp-endpoints-tools"},{"title":"Probe an MCP tool (runs the real action)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /integrations/{kind}/tools/{tool}/probe","href":"/api-reference/integrations/probe-an-mcp-tool-runs-the-real-action"},{"title":"Resolve one enabled agentic action (Zapier) or one Composio tool into a pinnable schema","deprecated":null,"version":null,"openapi":"/openapi.yaml post /integrations/{kind}/tools/{tool}/resolve","href":"/api-reference/integrations/resolve-one-enabled-agentic-action-zapier-or-one-composio-tool-into-a-pinnable-schema"},{"title":"Search a connected agentic account's available actions to enable (Zapier)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /integrations/{kind}/tools/discover","href":"/api-reference/integrations/search-a-connected-agentic-accounts-available-actions-to-enable-zapier"},{"title":"Turn one discovered agentic action ON so it can be resolved and frozen (Zapier)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /integrations/{kind}/enable","href":"/api-reference/integrations/turn-one-discovered-agentic-action-on-so-it-can-be-resolved-and-frozen-zapier"},{"title":"Look up a connected spreadsheet","deprecated":null,"version":null,"openapi":"/openapi.yaml get /integrations/{kind}/spreadsheet","href":"/api-reference/integrations/look-up-a-connected-spreadsheet"},{"title":"Discover an integration's schema","deprecated":null,"version":null,"openapi":"/openapi.yaml post /integrations/{kind}/discover","href":"/api-reference/integrations/discover-an-integrations-schema"},{"title":"Test a database connection","deprecated":null,"version":null,"openapi":"/openapi.yaml post /integrations/{kind}/sql/test","href":"/api-reference/integrations/test-a-database-connection"},{"title":"Generate database setup scripts","deprecated":null,"version":null,"openapi":"/openapi.yaml get /integrations/{kind}/sql/scripts","href":"/api-reference/integrations/generate-database-setup-scripts"},{"title":"Get a connection's data scoping","deprecated":null,"version":null,"openapi":"/openapi.yaml get /integrations/{kind}/scoping","href":"/api-reference/integrations/get-a-connections-data-scoping"},{"title":"Set a connection's data scoping","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /integrations/{kind}/scoping","href":"/api-reference/integrations/set-a-connections-data-scoping"},{"title":"Get a connection's write-back settings","deprecated":null,"version":null,"openapi":"/openapi.yaml get /integrations/{kind}/writeback","href":"/api-reference/integrations/get-a-connections-write-back-settings"},{"title":"Set a connection's write-back settings","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /integrations/{kind}/writeback","href":"/api-reference/integrations/set-a-connections-write-back-settings"},{"title":"Get a connection's softphone contact-card spec","deprecated":null,"version":null,"openapi":"/openapi.yaml get /integrations/{kind}/contact-card","href":"/api-reference/integrations/get-a-connections-softphone-contact-card-spec"},{"title":"Set a connection's softphone contact-card spec","deprecated":null,"version":null,"openapi":"/openapi.yaml put /integrations/{kind}/contact-card","href":"/api-reference/integrations/set-a-connections-softphone-contact-card-spec"},{"title":"Dry-run the softphone contact card against a number","deprecated":null,"version":null,"openapi":"/openapi.yaml post /integrations/{kind}/contact-card/probe","href":"/api-reference/integrations/dry-run-the-softphone-contact-card-against-a-number"},{"title":"Get an integration's discovered schema","deprecated":null,"version":null,"openapi":"/openapi.yaml get /integrations/{kind}/schema","href":"/api-reference/integrations/get-an-integrations-discovered-schema"},{"title":"Browse a provider's objects","deprecated":null,"version":null,"openapi":"/openapi.yaml get /integrations/{kind}/objects","href":"/api-reference/integrations/browse-a-providers-objects"},{"title":"Get one object's detail","deprecated":null,"version":null,"openapi":"/openapi.yaml get /integrations/{kind}/objects/{object}","href":"/api-reference/integrations/get-one-objects-detail"},{"title":"Browse a provider's operations","deprecated":null,"version":null,"openapi":"/openapi.yaml get /integrations/{kind}/operations","href":"/api-reference/integrations/browse-a-providers-operations"},{"title":"Search a provider's schema","deprecated":null,"version":null,"openapi":"/openapi.yaml get /integrations/{kind}/search","href":"/api-reference/integrations/search-a-providers-schema"},{"title":"Get a provider's preset pack","deprecated":null,"version":null,"openapi":"/openapi.yaml get /integrations/{kind}/pack","href":"/api-reference/integrations/get-a-providers-preset-pack"},{"title":"Get a connector's author guidance","deprecated":null,"version":null,"openapi":"/openapi.yaml get /integrations/{kind}/guidance","href":"/api-reference/integrations/get-a-connectors-author-guidance"},{"title":"List a provider's declarative trigger events (the outbound-automation catalog)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /integrations/{kind}/triggers","href":"/api-reference/integrations/list-a-providers-declarative-trigger-events-the-outbound-automation-catalog"},{"title":"Disconnect an integration","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /integrations/{kind}","href":"/api-reference/integrations/disconnect-an-integration"}]},{"group":"Outbound","pages":[{"title":"Compile an outbound trigger (when {event} → call) onto an agent","deprecated":null,"version":null,"openapi":"/openapi.yaml post /agents/{agentId}/integrations/{kind}/triggers","href":"/api-reference/outbound/compile-an-outbound-trigger-when--→-call-onto-an-agent"},{"title":"Auto-map a goal to an outbound trigger binding (the AI assistant)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /agents/{agentId}/integrations/{kind}/triggers/auto","href":"/api-reference/outbound/auto-map-a-goal-to-an-outbound-trigger-binding-the-ai-assistant"},{"title":"Enqueue a single outbound call","deprecated":null,"version":null,"openapi":"/openapi.yaml post /outbound/calls","href":"/api-reference/outbound/enqueue-a-single-outbound-call"},{"title":"List your outbound contact lists","deprecated":null,"version":null,"openapi":"/openapi.yaml get /outbound/lists","href":"/api-reference/outbound/list-your-outbound-contact-lists"},{"title":"Create an outbound contact list","deprecated":null,"version":null,"openapi":"/openapi.yaml post /outbound/lists","href":"/api-reference/outbound/create-an-outbound-contact-list"},{"title":"Get an outbound contact list and its counts","deprecated":null,"version":null,"openapi":"/openapi.yaml get /outbound/lists/{id}","href":"/api-reference/outbound/get-an-outbound-contact-list-and-its-counts"},{"title":"Import contacts into a list from a CSV (multipart)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /outbound/lists/{id}/import","href":"/api-reference/outbound/import-contacts-into-a-list-from-a-csv-multipart"},{"title":"Import contacts into a list from JSON rows","deprecated":null,"version":null,"openapi":"/openapi.yaml post /outbound/lists/{id}/contacts","href":"/api-reference/outbound/import-contacts-into-a-list-from-json-rows"},{"title":"List your outbound campaigns","deprecated":null,"version":null,"openapi":"/openapi.yaml get /outbound/campaigns","href":"/api-reference/outbound/list-your-outbound-campaigns"},{"title":"Create an outbound campaign (draft)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /outbound/campaigns","href":"/api-reference/outbound/create-an-outbound-campaign-draft"},{"title":"Get an outbound campaign and its attempt rollup","deprecated":null,"version":null,"openapi":"/openapi.yaml get /outbound/campaigns/{id}","href":"/api-reference/outbound/get-an-outbound-campaign-and-its-attempt-rollup"},{"title":"Launch a campaign (begins dialing)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /outbound/campaigns/{id}/launch","href":"/api-reference/outbound/launch-a-campaign-begins-dialing"},{"title":"Pause a running campaign","deprecated":null,"version":null,"openapi":"/openapi.yaml post /outbound/campaigns/{id}/pause","href":"/api-reference/outbound/pause-a-running-campaign"},{"title":"Resume a paused campaign","deprecated":null,"version":null,"openapi":"/openapi.yaml post /outbound/campaigns/{id}/resume","href":"/api-reference/outbound/resume-a-paused-campaign"},{"title":"Cancel a campaign","deprecated":null,"version":null,"openapi":"/openapi.yaml post /outbound/campaigns/{id}/cancel","href":"/api-reference/outbound/cancel-a-campaign"},{"title":"List your outbound triggers","deprecated":null,"version":null,"openapi":"/openapi.yaml get /outbound/triggers","href":"/api-reference/outbound/list-your-outbound-triggers"},{"title":"Get an outbound trigger","deprecated":null,"version":null,"openapi":"/openapi.yaml get /outbound/triggers/{id}","href":"/api-reference/outbound/get-an-outbound-trigger"},{"title":"Delete an outbound trigger","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /outbound/triggers/{id}","href":"/api-reference/outbound/delete-an-outbound-trigger"},{"title":"Enable or disable an outbound trigger","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /outbound/triggers/{id}","href":"/api-reference/outbound/enable-or-disable-an-outbound-trigger"},{"title":"List your standing inbound-webhook tokens","deprecated":null,"version":null,"openapi":"/openapi.yaml get /outbound/webhook-tokens","href":"/api-reference/outbound/list-your-standing-inbound-webhook-tokens"},{"title":"Mint a standing inbound-webhook token","deprecated":null,"version":null,"openapi":"/openapi.yaml post /outbound/webhook-tokens","href":"/api-reference/outbound/mint-a-standing-inbound-webhook-token"},{"title":"Revoke an inbound-webhook token","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /outbound/webhook-tokens/{id}","href":"/api-reference/outbound/revoke-an-inbound-webhook-token"},{"title":"List consent records (optionally for one number)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /outbound/consent-records","href":"/api-reference/outbound/list-consent-records-optionally-for-one-number"},{"title":"Record one PEWC consent proof","deprecated":null,"version":null,"openapi":"/openapi.yaml post /outbound/consent-records","href":"/api-reference/outbound/record-one-pewc-consent-proof"},{"title":"Bulk-import attested PEWC consent","deprecated":null,"version":null,"openapi":"/openapi.yaml post /outbound/consent-records/import","href":"/api-reference/outbound/bulk-import-attested-pewc-consent"},{"title":"Revoke a consent record (append-only stamp)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /outbound/consent-records/{id}/revoke","href":"/api-reference/outbound/revoke-a-consent-record-append-only-stamp"},{"title":"Marketing onboarding state + readiness checklist","deprecated":null,"version":null,"openapi":"/openapi.yaml get /outbound/marketing/onboarding","href":"/api-reference/outbound/marketing-onboarding-state-+-readiness-checklist"},{"title":"Submit seller identity + DNC SAN","deprecated":null,"version":null,"openapi":"/openapi.yaml post /outbound/marketing/onboarding","href":"/api-reference/outbound/submit-seller-identity-+-dnc-san"},{"title":"Store the org's PEWC opt-in disclosure copy","deprecated":null,"version":null,"openapi":"/openapi.yaml post /outbound/marketing/onboarding/disclosure","href":"/api-reference/outbound/store-the-orgs-pewc-opt-in-disclosure-copy"},{"title":"List a contact list's sync sources","deprecated":null,"version":null,"openapi":"/openapi.yaml get /outbound/lists/{id}/sources","href":"/api-reference/outbound/list-a-contact-lists-sync-sources"},{"title":"Add a sync source to a contact list","deprecated":null,"version":null,"openapi":"/openapi.yaml post /outbound/lists/{id}/sources","href":"/api-reference/outbound/add-a-sync-source-to-a-contact-list"},{"title":"Delete a sync source","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /outbound/lists/{id}/sources/{sourceId}","href":"/api-reference/outbound/delete-a-sync-source"},{"title":"Update a sync source","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /outbound/lists/{id}/sources/{sourceId}","href":"/api-reference/outbound/update-a-sync-source"},{"title":"Trigger a sync now","deprecated":null,"version":null,"openapi":"/openapi.yaml post /outbound/lists/{id}/sources/{sourceId}/sync","href":"/api-reference/outbound/trigger-a-sync-now"},{"title":"List a contact list's sync runs","deprecated":null,"version":null,"openapi":"/openapi.yaml get /outbound/lists/{id}/sync-runs","href":"/api-reference/outbound/list-a-contact-lists-sync-runs"}]},{"group":"Knowledge","pages":[{"title":"List knowledge sources","deprecated":null,"version":null,"openapi":"/openapi.yaml get /agents/{agentId}/knowledge/sources","href":"/api-reference/knowledge/list-knowledge-sources"},{"title":"Add a knowledge source","deprecated":null,"version":null,"openapi":"/openapi.yaml post /agents/{agentId}/knowledge/sources","href":"/api-reference/knowledge/add-a-knowledge-source"},{"title":"Get a knowledge source","deprecated":null,"version":null,"openapi":"/openapi.yaml get /agents/{agentId}/knowledge/sources/{id}","href":"/api-reference/knowledge/get-a-knowledge-source"},{"title":"Delete a knowledge source","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /agents/{agentId}/knowledge/sources/{id}","href":"/api-reference/knowledge/delete-a-knowledge-source"},{"title":"Set a knowledge source's auto-refresh","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /agents/{agentId}/knowledge/sources/{id}","href":"/api-reference/knowledge/set-a-knowledge-sources-auto-refresh"},{"title":"Refresh a knowledge source now","deprecated":null,"version":null,"openapi":"/openapi.yaml post /agents/{agentId}/knowledge/sources/{id}/refresh","href":"/api-reference/knowledge/refresh-a-knowledge-source-now"},{"title":"Preview knowledge search","deprecated":null,"version":null,"openapi":"/openapi.yaml post /agents/{agentId}/knowledge/preview","href":"/api-reference/knowledge/preview-knowledge-search"}]},{"group":"Playbooks","pages":[{"title":"List playbooks","deprecated":null,"version":null,"openapi":"/openapi.yaml get /agents/{agentId}/playbooks","href":"/api-reference/playbooks/list-playbooks"},{"title":"Create a playbook","deprecated":null,"version":null,"openapi":"/openapi.yaml post /agents/{agentId}/playbooks","href":"/api-reference/playbooks/create-a-playbook"},{"title":"Get a playbook","deprecated":null,"version":null,"openapi":"/openapi.yaml get /agents/{agentId}/playbooks/{id}","href":"/api-reference/playbooks/get-a-playbook"},{"title":"Delete a playbook","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /agents/{agentId}/playbooks/{id}","href":"/api-reference/playbooks/delete-a-playbook"},{"title":"Update a playbook","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /agents/{agentId}/playbooks/{id}","href":"/api-reference/playbooks/update-a-playbook"},{"title":"Get a playbook's steps","deprecated":null,"version":null,"openapi":"/openapi.yaml get /agents/{agentId}/playbooks/{id}/graph","href":"/api-reference/playbooks/get-a-playbooks-steps"},{"title":"Replace a playbook's steps","deprecated":null,"version":null,"openapi":"/openapi.yaml put /agents/{agentId}/playbooks/{id}/graph","href":"/api-reference/playbooks/replace-a-playbooks-steps"},{"title":"Check a playbook for problems before it goes live","deprecated":null,"version":null,"openapi":"/openapi.yaml post /agents/{agentId}/playbooks/{id}/verify","href":"/api-reference/playbooks/check-a-playbook-for-problems-before-it-goes-live"}]},{"group":"Variables","pages":[{"title":"List interaction variables","deprecated":null,"version":null,"openapi":"/openapi.yaml get /agents/{agentId}/variables","href":"/api-reference/variables/list-interaction-variables"},{"title":"Declare or annotate a variable","deprecated":null,"version":null,"openapi":"/openapi.yaml post /agents/{agentId}/variables","href":"/api-reference/variables/declare-or-annotate-a-variable"},{"title":"Delete a variable annotation","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /agents/{agentId}/variables/{name}","href":"/api-reference/variables/delete-a-variable-annotation"},{"title":"Edit a variable annotation","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /agents/{agentId}/variables/{name}","href":"/api-reference/variables/edit-a-variable-annotation"}]},{"group":"Guardrails","pages":[{"title":"Get guardrail policies","deprecated":null,"version":null,"openapi":"/openapi.yaml get /agents/{agentId}/guardrails","href":"/api-reference/guardrails/get-guardrail-policies"},{"title":"Replace guardrail policies","deprecated":null,"version":null,"openapi":"/openapi.yaml put /agents/{agentId}/guardrails","href":"/api-reference/guardrails/replace-guardrail-policies"},{"title":"Get caller verification settings","deprecated":null,"version":null,"openapi":"/openapi.yaml get /agents/{agentId}/caller-verification","href":"/api-reference/guardrails/get-caller-verification-settings"},{"title":"Replace caller verification settings","deprecated":null,"version":null,"openapi":"/openapi.yaml put /agents/{agentId}/caller-verification","href":"/api-reference/guardrails/replace-caller-verification-settings"}]},{"group":"Numbers","pages":[{"title":"List your phone numbers","deprecated":null,"version":null,"openapi":"/openapi.yaml get /numbers","href":"/api-reference/numbers/list-your-phone-numbers"},{"title":"Search available numbers","deprecated":null,"version":null,"openapi":"/openapi.yaml get /numbers/search","href":"/api-reference/numbers/search-available-numbers"},{"title":"Check one available number","deprecated":null,"version":null,"openapi":"/openapi.yaml get /numbers/available/{e164}","href":"/api-reference/numbers/check-one-available-number"},{"title":"Reserve a number before buying","deprecated":null,"version":null,"openapi":"/openapi.yaml post /numbers/reserve","href":"/api-reference/numbers/reserve-a-number-before-buying"},{"title":"Release a number hold","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /numbers/reserve/{id}","href":"/api-reference/numbers/release-a-number-hold"},{"title":"Buy a phone number","deprecated":null,"version":null,"openapi":"/openapi.yaml post /numbers/purchase","href":"/api-reference/numbers/buy-a-phone-number"},{"title":"Import a number you already own","deprecated":null,"version":null,"openapi":"/openapi.yaml post /numbers/import","href":"/api-reference/numbers/import-a-number-you-already-own"},{"title":"Check whether numbers can be ported in","deprecated":null,"version":null,"openapi":"/openapi.yaml post /numbers/port/precheck","href":"/api-reference/numbers/check-whether-numbers-can-be-ported-in"},{"title":"List port-in requests","deprecated":null,"version":null,"openapi":"/openapi.yaml get /numbers/port","href":"/api-reference/numbers/list-port-in-requests"},{"title":"Start a port-in request (draft)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /numbers/port","href":"/api-reference/numbers/start-a-port-in-request-draft"},{"title":"Get a port-in request","deprecated":null,"version":null,"openapi":"/openapi.yaml get /numbers/port/{id}","href":"/api-reference/numbers/get-a-port-in-request"},{"title":"Delete a draft port-in request","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /numbers/port/{id}","href":"/api-reference/numbers/delete-a-draft-port-in-request"},{"title":"Edit a port-in request","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /numbers/port/{id}","href":"/api-reference/numbers/edit-a-port-in-request"},{"title":"Sign the letter of authorization","deprecated":null,"version":null,"openapi":"/openapi.yaml post /numbers/port/{id}/sign","href":"/api-reference/numbers/sign-the-letter-of-authorization"},{"title":"Submit a port-in request","deprecated":null,"version":null,"openapi":"/openapi.yaml post /numbers/port/{id}/submit","href":"/api-reference/numbers/submit-a-port-in-request"},{"title":"Set per-number agent pre-assignments","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /numbers/port/{id}/assignments","href":"/api-reference/numbers/set-per-number-agent-pre-assignments"},{"title":"Cancel a port-in request","deprecated":null,"version":null,"openapi":"/openapi.yaml post /numbers/port/{id}/cancel","href":"/api-reference/numbers/cancel-a-port-in-request"},{"title":"Assign a number to an agent","deprecated":null,"version":null,"openapi":"/openapi.yaml post /numbers/{id}/assign","href":"/api-reference/numbers/assign-a-number-to-an-agent"},{"title":"Unassign a number","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /numbers/{id}/assign","href":"/api-reference/numbers/unassign-a-number"},{"title":"Release a number","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /numbers/{id}","href":"/api-reference/numbers/release-a-number"},{"title":"Set or clear a number's display label","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /numbers/{id}","href":"/api-reference/numbers/set-or-clear-a-numbers-display-label"}]},{"group":"Test","pages":[{"title":"Simulate a conversation","deprecated":null,"version":null,"openapi":"/openapi.yaml post /agents/{agentId}/simulate","href":"/api-reference/test/simulate-a-conversation"},{"title":"Start an in-browser voice test","deprecated":null,"version":null,"openapi":"/openapi.yaml post /agents/{agentId}/talk-token","href":"/api-reference/test/start-an-in-browser-voice-test"},{"title":"Start a probe run","deprecated":null,"version":null,"openapi":"/openapi.yaml post /agents/{agentId}/probe/run","href":"/api-reference/test/start-a-probe-run"},{"title":"Get a probe run result","deprecated":null,"version":null,"openapi":"/openapi.yaml get /agents/{agentId}/probe/runs/{runId}","href":"/api-reference/test/get-a-probe-run-result"},{"title":"Stream probe run progress","deprecated":null,"version":null,"openapi":"/openapi.yaml get /agents/{agentId}/probe/runs/{runId}/stream","href":"/api-reference/test/stream-probe-run-progress"}]},{"group":"Observe","pages":[{"title":"Get agent analytics","deprecated":null,"version":null,"openapi":"/openapi.yaml get /agents/{agentId}/analytics","href":"/api-reference/observe/get-agent-analytics"},{"title":"Get agent trend over time","deprecated":null,"version":null,"openapi":"/openapi.yaml get /agents/{agentId}/analytics/timeseries","href":"/api-reference/observe/get-agent-trend-over-time"},{"title":"List knowledge gaps","deprecated":null,"version":null,"openapi":"/openapi.yaml get /agents/{agentId}/knowledge-gaps","href":"/api-reference/observe/list-knowledge-gaps"},{"title":"Update a knowledge gap","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /agents/{agentId}/knowledge-gaps/{gapId}","href":"/api-reference/observe/update-a-knowledge-gap"},{"title":"The exact moments behind a knowledge gap (M4 drill)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /agents/{agentId}/knowledge-gaps/{gapId}/occurrences","href":"/api-reference/observe/the-exact-moments-behind-a-knowledge-gap-m4-drill"},{"title":"List conversation topics","deprecated":null,"version":null,"openapi":"/openapi.yaml get /agents/{agentId}/topics","href":"/api-reference/observe/list-conversation-topics"},{"title":"List conversations for a topic","deprecated":null,"version":null,"openapi":"/openapi.yaml get /agents/{agentId}/topics/{clusterId}/conversations","href":"/api-reference/observe/list-conversations-for-a-topic"},{"title":"Get account analytics overview","deprecated":null,"version":null,"openapi":"/openapi.yaml get /analytics/overview","href":"/api-reference/observe/get-account-analytics-overview"},{"title":"Get analytics per agent","deprecated":null,"version":null,"openapi":"/openapi.yaml get /analytics/by-agent","href":"/api-reference/observe/get-analytics-per-agent"},{"title":"Get account trend over time","deprecated":null,"version":null,"openapi":"/openapi.yaml get /analytics/timeseries","href":"/api-reference/observe/get-account-trend-over-time"},{"title":"The Observe metric catalog (self-describing registry)","description":"The complete, self-describing metric registry — everything a client (or an LLM holding only an API key + this contract) needs to compose a dashboard WITHOUT any out-of-band knowledge. Each entry names the metric's `unit`/`format` (how to render the number), its `agg`/`grain` (how it is computed), the `dimensions` it accepts as filter lenses, and — critically — its `allowedViz` (the ONLY visualizations this metric may render as; `defaultViz` is the natural pick) and its `target` thresholds.\nTwo flags gate composition: `requiresCapture` is non-empty (\"coming soon\") when the metric depends on a data-capture pass not yet emitting — such a metric is discoverable but should be shown disabled, not placed live; `hasDrilldown` says whether `GET /metrics/{id}/calls` will return the conversations behind the number. A widget's `viz` MUST be one of that metric's `allowedViz` or the dashboard write is rejected.\nThis registry is the general, forward path for analytics — the composable engine behind Observe. The bespoke `/analytics/*` endpoints (getOrgAnalyticsOverview, getOrgAnalyticsByAgent, getOrgAnalyticsTimeseries, getAgentAnalytics) are pre-built, fixed money cards that compute similar numbers; reach for the registry when you want to pick and chart metrics yourself, and for the fixed cards when you just want the ready-made hero numbers.\n","deprecated":null,"version":null,"openapi":"/openapi.yaml get /metrics/catalog","href":"/api-reference/observe/the-observe-metric-catalog-self-describing-registry"},{"title":"Query one metric over a filter window","deprecated":null,"version":null,"openapi":"/openapi.yaml get /metrics/{id}","href":"/api-reference/observe/query-one-metric-over-a-filter-window"},{"title":"The conversations behind a metric number (drill-down)","description":"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).\nUse 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).\n","deprecated":null,"version":null,"openapi":"/openapi.yaml get /metrics/{id}/calls","href":"/api-reference/observe/the-conversations-behind-a-metric-number-drill-down"},{"title":"List saved dashboards","deprecated":null,"version":null,"openapi":"/openapi.yaml get /dashboards","href":"/api-reference/observe/list-saved-dashboards"},{"title":"Create a dashboard","deprecated":null,"version":null,"openapi":"/openapi.yaml post /dashboards","href":"/api-reference/observe/create-a-dashboard"},{"title":"Get a dashboard","deprecated":null,"version":null,"openapi":"/openapi.yaml get /dashboards/{id}","href":"/api-reference/observe/get-a-dashboard"},{"title":"Update a dashboard (full-document replace)","deprecated":null,"version":null,"openapi":"/openapi.yaml put /dashboards/{id}","href":"/api-reference/observe/update-a-dashboard-full-document-replace"},{"title":"Delete a dashboard","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /dashboards/{id}","href":"/api-reference/observe/delete-a-dashboard"},{"title":"The org's Settings→Activity trail (what any user — and Flowyte staff — did)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /activity","href":"/api-reference/observe/the-orgs-settings→activity-trail-what-any-user-—-and-flowyte-staff-—-did"},{"title":"List scheduled reports","deprecated":null,"version":null,"openapi":"/openapi.yaml get /report-schedules","href":"/api-reference/observe/list-scheduled-reports"},{"title":"Create a scheduled report","deprecated":null,"version":null,"openapi":"/openapi.yaml post /report-schedules","href":"/api-reference/observe/create-a-scheduled-report"},{"title":"Get a scheduled report","deprecated":null,"version":null,"openapi":"/openapi.yaml get /report-schedules/{id}","href":"/api-reference/observe/get-a-scheduled-report"},{"title":"Update a scheduled report","deprecated":null,"version":null,"openapi":"/openapi.yaml put /report-schedules/{id}","href":"/api-reference/observe/update-a-scheduled-report"},{"title":"Delete a scheduled report","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /report-schedules/{id}","href":"/api-reference/observe/delete-a-scheduled-report"},{"title":"List conversations","deprecated":null,"version":null,"openapi":"/openapi.yaml get /conversations","href":"/api-reference/observe/list-conversations"},{"title":"Get a conversation","deprecated":null,"version":null,"openapi":"/openapi.yaml get /conversations/{id}","href":"/api-reference/observe/get-a-conversation"},{"title":"Get a conversation receipt","deprecated":null,"version":null,"openapi":"/openapi.yaml get /conversations/{id}/receipt","href":"/api-reference/observe/get-a-conversation-receipt"},{"title":"Get a conversation transcript","deprecated":null,"version":null,"openapi":"/openapi.yaml get /conversations/{id}/transcript","href":"/api-reference/observe/get-a-conversation-transcript"}]},{"group":"Billing","pages":[{"title":"List billing plans","deprecated":null,"version":null,"openapi":"/openapi.yaml get /billing/plans","href":"/api-reference/billing/list-billing-plans"},{"title":"Get current subscription","deprecated":null,"version":null,"openapi":"/openapi.yaml get /billing/subscription","href":"/api-reference/billing/get-current-subscription"},{"title":"Change subscription plan","deprecated":null,"version":null,"openapi":"/openapi.yaml post /billing/subscription","href":"/api-reference/billing/change-subscription-plan"},{"title":"Get wallet balance","deprecated":null,"version":null,"openapi":"/openapi.yaml get /billing/wallet","href":"/api-reference/billing/get-wallet-balance"},{"title":"Add credit to the wallet","deprecated":null,"version":null,"openapi":"/openapi.yaml post /billing/wallet/credit","href":"/api-reference/billing/add-credit-to-the-wallet"},{"title":"Top up the wallet by card","deprecated":null,"version":null,"openapi":"/openapi.yaml post /billing/wallet/topup","href":"/api-reference/billing/top-up-the-wallet-by-card"},{"title":"Configure wallet auto-reload","deprecated":null,"version":null,"openapi":"/openapi.yaml put /billing/wallet/auto-reload","href":"/api-reference/billing/configure-wallet-auto-reload"},{"title":"List usage records","deprecated":null,"version":null,"openapi":"/openapi.yaml get /billing/usage","href":"/api-reference/billing/list-usage-records"},{"title":"List invoices","deprecated":null,"version":null,"openapi":"/openapi.yaml get /billing/invoices","href":"/api-reference/billing/list-invoices"},{"title":"List itemized usage charges","deprecated":null,"version":null,"openapi":"/openapi.yaml get /billing/usage/items","href":"/api-reference/billing/list-itemized-usage-charges"}]},{"group":"Voices","pages":[{"title":"List the voice catalog","deprecated":null,"version":null,"openapi":"/openapi.yaml get /voices","href":"/api-reference/voices/list-the-voice-catalog"},{"title":"Get voice filter counts","deprecated":null,"version":null,"openapi":"/openapi.yaml get /voices/facets","href":"/api-reference/voices/get-voice-filter-counts"},{"title":"Search voices by description","deprecated":null,"version":null,"openapi":"/openapi.yaml post /voices/search","href":"/api-reference/voices/search-voices-by-description"}]},{"group":"ApiKeys","pages":[{"title":"List API keys","deprecated":null,"version":null,"openapi":"/openapi.yaml get /api-keys","href":"/api-reference/apikeys/list-api-keys"},{"title":"Create an API key (token shown once)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api-keys","href":"/api-reference/apikeys/create-an-api-key-token-shown-once"},{"title":"Rotate an API key (new token shown once)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /api-keys/{id}/rotate","href":"/api-reference/apikeys/rotate-an-api-key-new-token-shown-once"},{"title":"Revoke an API key","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /api-keys/{id}","href":"/api-reference/apikeys/revoke-an-api-key"}]},{"group":"Webhooks","pages":[{"title":"List webhook endpoints","deprecated":null,"version":null,"openapi":"/openapi.yaml get /webhooks","href":"/api-reference/webhooks/list-webhook-endpoints"},{"title":"Create a webhook endpoint","deprecated":null,"version":null,"openapi":"/openapi.yaml post /webhooks","href":"/api-reference/webhooks/create-a-webhook-endpoint"},{"title":"Get a webhook endpoint","deprecated":null,"version":null,"openapi":"/openapi.yaml get /webhooks/{id}","href":"/api-reference/webhooks/get-a-webhook-endpoint"},{"title":"Delete a webhook endpoint","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /webhooks/{id}","href":"/api-reference/webhooks/delete-a-webhook-endpoint"},{"title":"Update a webhook endpoint","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /webhooks/{id}","href":"/api-reference/webhooks/update-a-webhook-endpoint"},{"title":"Send a test delivery","deprecated":null,"version":null,"openapi":"/openapi.yaml post /webhooks/{id}/test","href":"/api-reference/webhooks/send-a-test-delivery"},{"title":"List webhook deliveries","deprecated":null,"version":null,"openapi":"/openapi.yaml get /webhooks/{id}/deliveries","href":"/api-reference/webhooks/list-webhook-deliveries"}]},{"group":"Escalation","pages":[{"title":"List escalation destinations","deprecated":null,"version":null,"openapi":"/openapi.yaml get /escalation-destinations","href":"/api-reference/escalation/list-escalation-destinations"},{"title":"Create an escalation destination (signing secret shown once)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /escalation-destinations","href":"/api-reference/escalation/create-an-escalation-destination-signing-secret-shown-once"},{"title":"Get an escalation destination","deprecated":null,"version":null,"openapi":"/openapi.yaml get /escalation-destinations/{id}","href":"/api-reference/escalation/get-an-escalation-destination"},{"title":"Delete an escalation destination (soft)","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /escalation-destinations/{id}","href":"/api-reference/escalation/delete-an-escalation-destination-soft"},{"title":"Update an escalation destination","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /escalation-destinations/{id}","href":"/api-reference/escalation/update-an-escalation-destination"},{"title":"Rotate the destination signing secret (new secret shown once)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /escalation-destinations/{id}/rotate-secret","href":"/api-reference/escalation/rotate-the-destination-signing-secret-new-secret-shown-once"},{"title":"Run the destination handshake (go-live gate)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /escalation-destinations/{id}/test","href":"/api-reference/escalation/run-the-destination-handshake-go-live-gate"},{"title":"List escalations","deprecated":null,"version":null,"openapi":"/openapi.yaml get /escalations","href":"/api-reference/escalation/list-escalations"},{"title":"Initiate an outbound escalation (harness-started SMS thread)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /escalations","href":"/api-reference/escalation/initiate-an-outbound-escalation-harness-started-sms-thread"},{"title":"Get an escalation","deprecated":null,"version":null,"openapi":"/openapi.yaml get /escalations/{id}","href":"/api-reference/escalation/get-an-escalation"},{"title":"Replay the conversation spine (sync / mailbox)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /escalations/{id}/messages","href":"/api-reference/escalation/replay-the-conversation-spine-sync-mailbox"},{"title":"Post a harness reply to the visitor","deprecated":null,"version":null,"openapi":"/openapi.yaml post /escalations/{id}/messages","href":"/api-reference/escalation/post-a-harness-reply-to-the-visitor"},{"title":"Claim an escalation","deprecated":null,"version":null,"openapi":"/openapi.yaml post /escalations/{id}/claim","href":"/api-reference/escalation/claim-an-escalation"},{"title":"Extend the claim lease","deprecated":null,"version":null,"openapi":"/openapi.yaml post /escalations/{id}/heartbeat","href":"/api-reference/escalation/extend-the-claim-lease"},{"title":"Send a typing indicator (chat only)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /escalations/{id}/typing","href":"/api-reference/escalation/send-a-typing-indicator-chat-only"},{"title":"Resolve an escalation","deprecated":null,"version":null,"openapi":"/openapi.yaml post /escalations/{id}/resolve","href":"/api-reference/escalation/resolve-an-escalation"},{"title":"Return the thread to the AI","deprecated":null,"version":null,"openapi":"/openapi.yaml post /escalations/{id}/return","href":"/api-reference/escalation/return-the-thread-to-the-ai"},{"title":"Request a human takeover","deprecated":null,"version":null,"openapi":"/openapi.yaml post /escalations/{id}/request-human","href":"/api-reference/escalation/request-a-human-takeover"},{"title":"Get an agent's escalation policy","deprecated":null,"version":null,"openapi":"/openapi.yaml get /agents/{id}/escalation-policy","href":"/api-reference/escalation/get-an-agents-escalation-policy"},{"title":"Replace an agent's escalation policy (writes the DRAFT)","deprecated":null,"version":null,"openapi":"/openapi.yaml put /agents/{id}/escalation-policy","href":"/api-reference/escalation/replace-an-agents-escalation-policy-writes-the-draft"}]},{"group":"AuditLogs","pages":[{"title":"List activity logs","deprecated":null,"version":null,"openapi":"/openapi.yaml get /audit-logs","href":"/api-reference/auditlogs/list-activity-logs"}]},{"group":"Chat","pages":[{"title":"Create a chat session","deprecated":null,"version":null,"openapi":"/openapi.yaml post /chat/sessions","href":"/api-reference/chat/create-a-chat-session"},{"title":"Get a chat session","deprecated":null,"version":null,"openapi":"/openapi.yaml get /chat/sessions/{id}","href":"/api-reference/chat/get-a-chat-session"},{"title":"List chat messages","deprecated":null,"version":null,"openapi":"/openapi.yaml get /chat/sessions/{id}/messages","href":"/api-reference/chat/list-chat-messages"},{"title":"Send a chat message","deprecated":null,"version":null,"openapi":"/openapi.yaml post /chat/sessions/{id}/messages","href":"/api-reference/chat/send-a-chat-message"},{"title":"End a chat session","deprecated":null,"version":null,"openapi":"/openapi.yaml post /chat/sessions/{id}/end","href":"/api-reference/chat/end-a-chat-session"},{"title":"OpenAI-compatible chat completions","deprecated":null,"version":null,"openapi":"/openapi.yaml post /chat/completions","href":"/api-reference/chat/openai-compatible-chat-completions"},{"title":"Start a widget chat session","deprecated":null,"version":null,"openapi":"/openapi.yaml post /chat/widget/sessions","href":"/api-reference/chat/start-a-widget-chat-session"},{"title":"Get widget bootstrap config","deprecated":null,"version":null,"openapi":"/openapi.yaml get /widget/bootstrap","href":"/api-reference/chat/get-widget-bootstrap-config"}]},{"group":"PublishableKeys","pages":[{"title":"List publishable keys","deprecated":null,"version":null,"openapi":"/openapi.yaml get /agents/{agentId}/publishable-keys","href":"/api-reference/publishablekeys/list-publishable-keys"},{"title":"Create a publishable key","deprecated":null,"version":null,"openapi":"/openapi.yaml post /agents/{agentId}/publishable-keys","href":"/api-reference/publishablekeys/create-a-publishable-key"},{"title":"Revoke a publishable key","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /agents/{agentId}/publishable-keys/{id}","href":"/api-reference/publishablekeys/revoke-a-publishable-key"},{"title":"Update a publishable key","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /agents/{agentId}/publishable-keys/{id}","href":"/api-reference/publishablekeys/update-a-publishable-key"},{"title":"Rotate a publishable key","deprecated":null,"version":null,"openapi":"/openapi.yaml post /agents/{agentId}/publishable-keys/{id}/rotate","href":"/api-reference/publishablekeys/rotate-a-publishable-key"}]},{"group":"Widget","pages":[{"title":"Get widget config","deprecated":null,"version":null,"openapi":"/openapi.yaml get /agents/{agentId}/widget","href":"/api-reference/widget/get-widget-config"},{"title":"Replace widget config","deprecated":null,"version":null,"openapi":"/openapi.yaml put /agents/{agentId}/widget","href":"/api-reference/widget/replace-widget-config"},{"title":"Get the widget embed snippet","deprecated":null,"version":null,"openapi":"/openapi.yaml get /agents/{agentId}/widget/embed","href":"/api-reference/widget/get-the-widget-embed-snippet"}]},{"group":"Uploads","pages":[{"title":"Upload a file","deprecated":null,"version":null,"openapi":"/openapi.yaml post /uploads","href":"/api-reference/uploads/upload-a-file"}]},{"group":"Meta","pages":[{"title":"Get language capability matrix","deprecated":null,"version":null,"openapi":"/openapi.yaml get /meta/languages","href":"/api-reference/meta/get-language-capability-matrix"},{"title":"Get your account info","deprecated":null,"version":null,"openapi":"/openapi.yaml get /meta/account","href":"/api-reference/meta/get-your-account-info"},{"title":"Update the organization's report settings (org/me write)","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /meta/account","href":"/api-reference/meta/update-the-organizations-report-settings-orgme-write"}]},{"group":"SMS","pages":[{"title":"Get the org's SMS (10DLC) registration, numbers, and status","deprecated":null,"version":null,"openapi":"/openapi.yaml get /sms","href":"/api-reference/sms/get-the-orgs-sms-10dlc-registration-numbers-and-status"},{"title":"Save the 10DLC registration draft (auto-generates compliant campaign text)","deprecated":null,"version":null,"openapi":"/openapi.yaml put /sms","href":"/api-reference/sms/save-the-10dlc-registration-draft-auto-generates-compliant-campaign-text"},{"title":"Run the AI compliance review on the saved draft (free, no charge)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /sms/review","href":"/api-reference/sms/run-the-ai-compliance-review-on-the-saved-draft-free-no-charge"},{"title":"Submit the 10DLC registration (billable — debits the activation fee)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /sms/submit","href":"/api-reference/sms/submit-the-10dlc-registration-billable-—-debits-the-activation-fee"},{"title":"Reconcile the registration status from the carrier (non-billable)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /sms/refresh","href":"/api-reference/sms/reconcile-the-registration-status-from-the-carrier-non-billable"},{"title":"List opted-out (do-not-text) contacts","deprecated":null,"version":null,"openapi":"/openapi.yaml get /sms/suppressions","href":"/api-reference/sms/list-opted-out-do-not-text-contacts"},{"title":"Manually record an opt-out (do-not-text)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /sms/suppressions","href":"/api-reference/sms/manually-record-an-opt-out-do-not-text"},{"title":"Re-enable a number (record new consent) — gated","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /sms/suppressions/{e164}","href":"/api-reference/sms/re-enable-a-number-record-new-consent-—-gated"},{"title":"List SMS contacts with consent status (Consent \u0026 contacts)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /sms/contacts","href":"/api-reference/sms/list-sms-contacts-with-consent-status-consent-\u0026-contacts"},{"title":"Export SMS contacts + consent as CSV (TCPA proof)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /sms/contacts/export","href":"/api-reference/sms/export-sms-contacts-+-consent-as-csv-tcpa-proof"},{"title":"Send an outbound text message from an SMS-enabled number","deprecated":null,"version":null,"openapi":"/openapi.yaml post /sms/messages","href":"/api-reference/sms/send-an-outbound-text-message-from-an-sms-enabled-number"},{"title":"Upload a picture or short video to send by text","deprecated":null,"version":null,"openapi":"/openapi.yaml post /sms/media","href":"/api-reference/sms/upload-a-picture-or-short-video-to-send-by-text"},{"title":"Get a download link for a text attachment","deprecated":null,"version":null,"openapi":"/openapi.yaml get /sms/media/{id}","href":"/api-reference/sms/get-a-download-link-for-a-text-attachment"},{"title":"Record a contact's express SMS consent captured outside a text","deprecated":null,"version":null,"openapi":"/openapi.yaml put /sms/contacts/{e164}/consent","href":"/api-reference/sms/record-a-contacts-express-sms-consent-captured-outside-a-text"},{"title":"Revoke the SMS consent your workspace recorded for a contact","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /sms/contacts/{e164}/consent","href":"/api-reference/sms/revoke-the-sms-consent-your-workspace-recorded-for-a-contact"},{"title":"Get an SMS contact","deprecated":null,"version":null,"openapi":"/openapi.yaml get /sms/contacts/{e164}","href":"/api-reference/sms/get-an-sms-contact"},{"title":"Pause the AI for a contact","deprecated":null,"version":null,"openapi":"/openapi.yaml put /sms/contacts/{e164}/ai-pause","href":"/api-reference/sms/pause-the-ai-for-a-contact"},{"title":"Resume the AI for a contact","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /sms/contacts/{e164}/ai-pause","href":"/api-reference/sms/resume-the-ai-for-a-contact"},{"title":"Enable or disable an owned number for SMS (assign to the campaign)","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /sms/numbers/{e164}","href":"/api-reference/sms/enable-or-disable-an-owned-number-for-sms-assign-to-the-campaign"}]},{"group":"Records","pages":[{"title":"List caller-context records","deprecated":null,"version":null,"openapi":"/openapi.yaml get /records","href":"/api-reference/records/list-caller-context-records"},{"title":"Upsert a caller-context record","deprecated":null,"version":null,"openapi":"/openapi.yaml put /records","href":"/api-reference/records/upsert-a-caller-context-record"},{"title":"Bulk-upsert caller-context records","deprecated":null,"version":null,"openapi":"/openapi.yaml post /records/bulk","href":"/api-reference/records/bulk-upsert-caller-context-records"},{"title":"Erase all caller-context records","deprecated":null,"version":null,"openapi":"/openapi.yaml post /records/purge","href":"/api-reference/records/erase-all-caller-context-records"},{"title":"Get a caller-context record","deprecated":null,"version":null,"openapi":"/openapi.yaml get /records/{objectType}/{externalId}","href":"/api-reference/records/get-a-caller-context-record"},{"title":"Delete a caller-context record","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /records/{objectType}/{externalId}","href":"/api-reference/records/delete-a-caller-context-record"},{"title":"List caller-context record types","deprecated":null,"version":null,"openapi":"/openapi.yaml get /record-types","href":"/api-reference/records/list-caller-context-record-types"},{"title":"Update a record type","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /record-types/{type}","href":"/api-reference/records/update-a-record-type"},{"title":"Get a record type's fields","deprecated":null,"version":null,"openapi":"/openapi.yaml get /record-types/{type}/fields","href":"/api-reference/records/get-a-record-types-fields"}]},{"group":"OAuth2","pages":[{"title":"Approve or deny an OAuth2 authorization (mints the code)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /oauth/consent","href":"/api-reference/oauth2/approve-or-deny-an-oauth2-authorization-mints-the-code"},{"title":"Disconnect an OAuth client (revoke all the org's tokens)","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /oauth/connections/{clientId}","href":"/api-reference/oauth2/disconnect-an-oauth-client-revoke-all-the-orgs-tokens"},{"title":"OAuth2 authorization endpoint (RFC 6749)","deprecated":null,"version":null,"openapi":"/openapi.yaml get /oauth/authorize","href":"/api-reference/oauth2/oauth2-authorization-endpoint-rfc-6749"},{"title":"OAuth2 token endpoint (RFC 6749 /)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /oauth/token","href":"/api-reference/oauth2/oauth2-token-endpoint-rfc-6749-"},{"title":"OAuth2 token revocation (RFC 7009)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /oauth/revoke","href":"/api-reference/oauth2/oauth2-token-revocation-rfc-7009"}]},{"group":"Team","pages":[{"title":"List team members, pending invitations, and the join-request count","deprecated":null,"version":null,"openapi":"/openapi.yaml get /team/members","href":"/api-reference/team/list-team-members-pending-invitations-and-the-join-request-count"},{"title":"Invite a teammate (no phone seat)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /team/invitations","href":"/api-reference/team/invite-a-teammate-no-phone-seat"},{"title":"Resend a pending invitation","deprecated":null,"version":null,"openapi":"/openapi.yaml post /team/invitations/{id}/resend","href":"/api-reference/team/resend-a-pending-invitation"},{"title":"Revoke a pending invitation","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /team/invitations/{id}","href":"/api-reference/team/revoke-a-pending-invitation"},{"title":"Remove a member from the workspace","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /team/members/{userId}","href":"/api-reference/team/remove-a-member-from-the-workspace"},{"title":"Change a member's role","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /team/members/{userId}","href":"/api-reference/team/change-a-members-role"},{"title":"List pending join requests","deprecated":null,"version":null,"openapi":"/openapi.yaml get /team/join-requests","href":"/api-reference/team/list-pending-join-requests"},{"title":"Approve a join request (send an invitation)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /team/join-requests/{id}/approve","href":"/api-reference/team/approve-a-join-request-send-an-invitation"},{"title":"Dismiss a join request","deprecated":null,"version":null,"openapi":"/openapi.yaml post /team/join-requests/{id}/dismiss","href":"/api-reference/team/dismiss-a-join-request"}]},{"group":"Onboarding","pages":[{"title":"Discover the workspace that invited you, or the one your email domain belongs to","deprecated":null,"version":null,"openapi":"/openapi.yaml post /onboarding/discover","href":"/api-reference/onboarding/discover-the-workspace-that-invited-you-or-the-one-your-email-domain-belongs-to"},{"title":"Ask to join the org your email domain matches","deprecated":null,"version":null,"openapi":"/openapi.yaml post /onboarding/join-requests","href":"/api-reference/onboarding/ask-to-join-the-org-your-email-domain-matches"}]}]}]},{"tab":"Resources","pages":[{"title":"Resources","href":"/resources/feature-matrix"}]}]},"basePath":"","title":"Query one metric over a filter window - Flowyte","deploymentId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","buildId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CiUHMMOm.js","snippetPresets-BgfXU7Bw.js","utils-DWvOwgy_.js","style-to-object-BY3JEAdk.js","utils-BN7RXSMJ.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-CFw8bq89.js","conditional-requirements-CFM0id0Q.js","cloneDeep-CAwdfOU2.js","_Uint8Array-BJr8e-ZL.js","isObject-FP1Yky1u.js","ApiExamples-XX0UgMZK.js","usePlaygroundInputsStore-DXDFSa1V.js","shallow-CdX5aREi.js","isEqual-CoOaxexF.js","CodeSnippets-Cg2wpzWm.js","CodeSnippet-D_HwgQO_.js","getApiPlaygroundDisplay-CmCoerhe.js","Page-CVJ-f_k1.js","DynamicMarkdown-CQM9Bhbv.js","SectionHeading-DpbrP8nQ.js","icon-BPCgijHy.js","MethodPill-GQ8DuY0c.js","getPastedJson-Cb5mT31m.js","Check2Icon-a7bUI6e8.js","axios-CsQoIw0U.js","Markdown-CX2QY19L.js","AssistantPageLink-CY3bFglh.js","dist-Dl6_zDnT.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}