> ## Documentation Index > Fetch the complete documentation index at: https://docs.flowyte.com/llms.txt > Use this file to discover all available pages before exploring further. # Get agent analytics > Returns post-call analytics for a single agent over a date range, including how many calls were answered, missed, contained, or transferred. Pass your average ticket value to estimate recovered revenue. Filter by channel (voice or chat). ## OpenAPI ````yaml /openapi.yaml get /agents/{agentId}/analytics openapi: 3.1.0 info: title: Flowyte V2 Control-Plane REST API version: 1.0.0 description: >- The single REST API for the Flowyte platform (base path `/api/v1`). Authenticate every request with a secret API key — `Authorization: Bearer flowyte_sk_…` — and each operation lists the scope the key must hold. Successful responses use the `ApiResponse` envelope; list responses use cursor-based `PaginatedResponse`. Errors are RFC 9457 problem+json. Streaming endpoints return Server-Sent Events (`event:\ndata:\n\n`, terminating with `event: done`). contact: name: Flowyte Platform license: name: Proprietary servers: - url: /api/v1 description: Flowyte control-plane (versioned URI; additive in v1). security: - apiKey: [] tags: - name: Agents description: The single user-facing entity. - name: Skills description: > Agent capabilities / tools. A skill is ONE atomic action — typically a single API call the agent makes in one step (look up an order, create a record, send a message, transfer the call). Use a skill when the task is a single step. When a task needs several details gathered across turns BEFORE acting, build a Playbook (which gathers the inputs and then calls skills) — see the Playbooks tag. - name: Integrations description: Native OAuth integrations. - name: Knowledge description: RAG knowledge sources & preview. - name: Playbooks description: > Multi-turn conversation scripts — a node graph (gather → confirm → branch) the agent follows to collect several inputs IN ORDER across turns before acting. Build a playbook when a single skill call isn't enough because the agent must gather MANY details first, or run a SEQUENCE of skills, before it can finish (e.g. take a full service request: gather the problem, address, and time, confirm, THEN file it; qualify a lead; a multi-step intake). A playbook does NOT call an integration itself — it owns the conversation and holds the state across turns; the actual action is performed by the SKILL(s) it gathers the inputs for. So a playbook ORCHESTRATES skills. Rule of thumb — one API call → a Skill; "gather N things in order, then submit" → a Playbook that drives the conversation and calls the skill(s) at the end. - name: Variables description: > The agent-wide interaction-variable registry (B.4b) — DERIVED at read time from the agent's playbooks and skills (collect slots, skill output bindings, {var} placeholders) and merged with a thin annotation overlay (notes, declared type hints, manual declarations). Read-only observation, NEVER a gate: it never validates a reference and never affects authoring, publish, or runtime behaviour. - name: Guardrails description: Deterministic guardrail policies & caller verification. - name: Numbers description: Phone numbers / DIDs. - name: Test description: Test, simulate, talk-token, probe. - name: Observe description: Post-call analytics, conversations, receipts, transcripts. - name: Billing description: Plans, wallet, usage, fixed phrases. - name: Voices description: Voice catalog. - name: Webhooks description: Webhook endpoints & deliveries. - name: AuditLogs description: API/key activity logs. - name: Chat description: Chat channel — sessions, messages, OpenAI-compatible, widget. - name: PublishableKeys description: Browser-safe, one-agent publishable keys. - name: Widget description: Embed widget config + snippet. - name: Uploads description: Multipart file uploads backing file_id params - name: Meta description: Platform metadata (language/SKU/tier capabilities). paths: /agents/{agentId}/analytics: parameters: - $ref: '#/components/parameters/AgentIdPathScoped' get: tags: - Observe summary: Get agent analytics description: >- Returns post-call analytics for a single agent over a date range, including how many calls were answered, missed, contained, or transferred. Pass your average ticket value to estimate recovered revenue. Filter by channel (voice or chat). operationId: getAgentAnalytics parameters: - name: from in: query schema: type: string format: date-time - name: to in: query schema: type: string format: date-time - name: channel in: query schema: type: string enum: - voice - chat - name: avgTicketCents in: query description: >- The customer's average ticket in integer cents (drives recoveredRevenueUsd). Takes precedence over avgTicketUsd. schema: type: integer minimum: 0 - name: avgTicketUsd in: query description: >- The customer's average ticket in dollars (used when avgTicketCents is absent). schema: type: number minimum: 0 responses: '200': description: Analytics. content: application/json: schema: $ref: '#/components/schemas/ApiResponse_AgentAnalytics' '404': $ref: '#/components/responses/NotFound' security: - apiKey: - analytics:read components: parameters: AgentIdPathScoped: name: agentId in: path required: true schema: type: string schemas: ApiResponse_AgentAnalytics: allOf: - $ref: '#/components/schemas/ApiResponseBase' - type: object required: - data properties: data: $ref: '#/components/schemas/AgentAnalytics' ApiResponseBase: type: object required: - success properties: success: type: boolean message: type: string errors: type: array items: type: object required: - field - message properties: field: type: string message: type: string AgentAnalytics: type: object description: > Post-call analytics. Includes `answerStats` — the answer-rate summary (missed/answered + after-hours split + captured count + recovered revenue, with the avg-ticket math). properties: containment: type: number transferRate: type: number p50ByLang: type: object additionalProperties: type: number p95ByLang: type: object additionalProperties: type: number costBreakdown: type: object additionalProperties: true charsPerMin: type: number byChannel: type: object additionalProperties: true answerStats: $ref: '#/components/schemas/AnswerStats' sentimentTriage: $ref: '#/components/schemas/SentimentTriage' topTopics: type: array description: >- M4: the windowed top topics ("what people are talking about"), volume desc. Empty below the volume floor. items: $ref: '#/components/schemas/TopicSummary' knowledgeGapsSummary: $ref: '#/components/schemas/KnowledgeGapsSummary' ProblemDetails: description: RFC 9457 problem+json. type: object properties: type: type: string format: uri default: about:blank title: type: string status: type: integer detail: type: string instance: type: string code: type: string errors: type: array items: type: object properties: field: type: string message: type: string AnswerStats: type: object description: > `recoveredRevenueUsd` = `capturedCalls` × `avgTicketUsd` (the customer's own configurable avg ticket, passed as `?avgTicketCents=` or `?avgTicketUsd=` on the analytics request) — the math is shown so the dollar is conservative and theirs. The after-hours vs business-hours split is the #1 thing owners check (62% of SMB calls go unanswered). required: - totalCalls - answeredCalls - missedCalls - completedCalls - transferredCalls - containmentRate - transferRate - answerRate - capturedCalls - recoveredRevenueUsd - avgTicketUsd properties: totalCalls: type: integer answeredCalls: type: integer missedCalls: type: integer completedCalls: type: integer description: >- outcome=completed count; completedCalls + transferredCalls + missedCalls = totalCalls transferredCalls: type: integer description: outcome=transferred count containmentRate: type: number description: completedCalls / totalCalls (0..1) transferRate: type: number description: transferredCalls / totalCalls (0..1) businessHoursAnswered: type: integer businessHoursTotal: type: integer afterHoursAnswered: type: integer afterHoursTotal: type: integer answerRate: type: number description: answeredCalls / totalCalls (0..1) businessHoursAnswerRate: type: number afterHoursAnswerRate: type: number capturedCalls: type: integer description: booking/goal-completed count avgTicketUsd: type: number recoveredRevenueUsd: type: number description: capturedCalls × avgTicketUsd SentimentTriage: type: object description: > Sentiment triage: the per-bucket counts PLUS the few worst calls to review (most-negative first) — the entry points into the correction loop. required: - positiveCount - neutralCount - negativeCount - frustratedCount - scoredCalls - worstCalls properties: positiveCount: type: integer neutralCount: type: integer negativeCount: type: integer frustratedCount: type: integer scoredCalls: type: integer description: calls carrying a sentiment (the denominator) worstCalls: type: array items: $ref: '#/components/schemas/SentimentCall' TopicSummary: type: object description: > One row of the topic rollup ("what people are talking about"). `label` is the LLM-assigned cluster name, "Other" until the cluster crosses the naming volume floor. `volume` is the windowed call count; `trendPct` is the percent change vs the prior equal-length window (0 when no prior data). required: - clusterId - label - volume - trendPct properties: clusterId: type: string label: type: string volume: type: integer trendPct: type: number sampleQueries: type: array items: type: string KnowledgeGapsSummary: type: object description: > M4 ranked-gaps headline folded into /analytics: the count of OPEN gaps + the single top gap by rankScore (the "fix this next" pointer). `dataState` is `collecting` below the clustering volume floor, else `ready`. required: - openCount - dataState properties: openCount: type: integer topGap: type: string dataState: type: string enum: - collecting - ready SentimentCall: type: object description: One row of the worst-calls review list (most-negative first). required: - conversationId - sentiment - sentimentScore properties: conversationId: type: string sentiment: type: string enum: - negative - frustrated sentimentScore: type: number summary: type: string startedAt: type: string format: date-time responses: NotFound: description: Resource not found in org scope. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' securitySchemes: 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. 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 & preview. knowledge:write: Add/remove knowledge sources, uploads. skills:read: Read skills & skill-types. skills:write: Create/update/delete skills. playbooks:read: Read playbooks & graphs. playbooks:write: Create/update/delete playbooks & graphs. guardrails:read: Read guardrail policies & caller-verification. guardrails:write: Update guardrail policies & 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:write: Save/submit the 10DLC registration and toggle numbers for SMS. 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. calls:read: Read conversations, receipts, transcripts, analytics. analytics:read: >- Read the Observe history list, per-agent analytics (the answer-rate summary), and the raw knowledge-gap list. analytics:write: >- Curate knowledge gaps (dismiss / mark in-progress). [M4 — reserved] 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 & messages. chat:write: Create chat sessions & send messages (server-side). widgets:read: Read widget config & embed snippet. widgets:write: Update widget config. pubkeys:read: Read publishable keys. pubkeys:write: Manage publishable keys. ````