> ## Documentation Index > Fetch the complete documentation index at: https://docs.orbit.devotel.io/llms.txt > Use this file to discover all available pages before exploring further. # Per-channel deliverability totals, trend and failure diagnostics > Deep deliverability report for a single channel over a rolling window: outbound totals (sent, accepted, delivered, read, terminal, failed, bounced, complained, unsubscribed), the derived delivery/read/failure rates, a per-bucket time-series bucketed in the tenant's billing timezone, and top-N failure-reason and (for SMS/voice) failure-country breakdowns. Powers the Deliverability dashboard's per-channel tab. Results are scoped to the caller's tenant and cached for 60s. ## OpenAPI ````yaml /openapi.yaml get /api/v1/analytics/deliverability openapi: 3.1.0 info: title: Devotel CPaaS API description: Orbit by Devotel — Communications Platform as a Service API version: 1.0.0 contact: name: Devotel url: https://devotel.io email: support@devotel.io license: name: Proprietary servers: - url: https://api.orbit.devotel.io description: Production security: - Bearer: [] - ApiKey: [] tags: - name: Messages description: >- Send and manage messages across all channels (SMS, WhatsApp, RCS, Email, Viber, etc.) - name: Fax description: >- List and track fax (MMS/T.38) transmissions on Telnyx-backed fax numbers (sending flows through the Messaging API) - name: Agents description: AI agent creation, configuration, and execution - name: Voice description: Voice calls, IVR, conferencing, and SIP trunking - name: OnCall description: On-call rotations and escalation policy planning for incident alerting - name: Webhooks description: Webhook endpoint management and delivery logs - name: Numbers description: Phone number search, provisioning, and configuration - name: Brand Identity description: >- Unified cross-channel brand trust posture (10DLC, toll-free, WhatsApp, RCS, branded calling, number KYC) - name: Contacts description: Contact management, segmentation, and lifecycle tracking - name: Campaigns description: Marketing campaign orchestration and analytics - name: Flows description: Automation flow builder and execution engine - name: Templates description: Message template management and approval workflows - name: Settings description: Organization, channel, and user preference settings - name: Verify description: OTP generation and verification across channels - name: Push description: Push notification delivery via FCM and APNs - name: Integrations description: Third-party service connections and OAuth management - name: CDP description: >- Customer Data Platform — activation surface (CRM object sync, streaming destinations, ad-audience activation) - name: Files description: >- Server-to-server media upload, listing, retrieval, and deletion (signed-URL backed) - name: Commerce description: >- Omnichannel conversational-commerce — persistent cart + checkout state machine, channel-agnostic hosted pay-by-link, native WhatsApp checkout, and AP2-style agent payment mandates. - name: Sync description: >- Real-time shared-state primitive (Twilio Sync parity) — Documents, Maps, Lists, and ephemeral Streams, with change events relayed over the /api/v1/ws/sync WebSocket gateway - name: Risk description: >- Unified cross-channel Trust & Fraud risk scoring — fuses SMS-pumping, URL-reputation, Verify Fraud Guard, and Voice Biometrics signals into one composite verdict queryable before a send or a call. - name: Orby description: >- In-dashboard Orby operator assistant: streamed assistant turns, conversation threads, product knowledge-base search, and the tool-action approval gate. Available to signed-in operators only (dashboard session auth — API-key requests are rejected). paths: /api/v1/analytics/deliverability: get: tags: - Analytics summary: Per-channel deliverability totals, trend and failure diagnostics description: >- Deep deliverability report for a single channel over a rolling window: outbound totals (sent, accepted, delivered, read, terminal, failed, bounced, complained, unsubscribed), the derived delivery/read/failure rates, a per-bucket time-series bucketed in the tenant's billing timezone, and top-N failure-reason and (for SMS/voice) failure-country breakdowns. Powers the Deliverability dashboard's per-channel tab. Results are scoped to the caller's tenant and cached for 60s. parameters: - name: channel in: query required: true schema: type: string enum: - sms - whatsapp - rcs - email - voice - instagram - messenger - viber description: >- Channel to report on. The dashboard renders one panel per channel tab. - name: window in: query required: false schema: type: string enum: - 24h - 7d - 30d default: 7d description: Rolling lookback window. - name: groupBy in: query required: false schema: type: string enum: - hour - day description: >- Time-series bucket size. Defaults to hour for the 24h window, day otherwise. responses: '200': description: >- Deliverability totals, rates, timezone-aware series and failure diagnostics for the channel. content: application/json: schema: type: object properties: data: type: object properties: channel: type: string window: type: string groupBy: type: string timezone: type: string description: IANA timezone the series buckets were computed in. totals: type: object properties: sent: type: integer accepted: type: integer delivered: type: integer read: type: integer terminal: type: integer description: >- Rows that reached a final state — the delivery/failure-rate denominator. failed: type: integer bounced: type: integer complained: type: integer unsubscribed: type: integer series: type: array items: type: object properties: ts: type: string format: date-time sent: type: integer accepted: type: integer delivered: type: integer read: type: integer terminal: type: integer failed: type: integer bounced: type: integer complained: type: integer unsubscribed: type: integer delivery_rate: type: number description: Delivered / terminal, 0–100. read_rate: type: number description: Read / delivered, 0–100. failure_rate: type: number description: Failed / terminal, 0–100. top_failure_reasons: type: array items: type: object properties: reason: type: string count: type: integer top_failure_countries: type: array items: type: object properties: country: type: string description: ISO-3166-1 alpha-2 country code, or OTHER. count: type: integer rate: type: number meta: type: object properties: request_id: type: string timestamp: type: string format: date-time example: data: channel: sms window: 7d groupBy: day timezone: America/New_York totals: sent: 12840 accepted: 120 delivered: 12611 read: 0 terminal: 12840 failed: 229 bounced: 0 complained: 0 unsubscribed: 34 series: - ts: '2026-08-01T04:00:00.000Z' sent: 1830 accepted: 10 delivered: 1798 read: 0 terminal: 1830 failed: 32 bounced: 0 complained: 0 unsubscribed: 5 delivery_rate: 98.22 read_rate: 0 failure_rate: 1.78 top_failure_reasons: - reason: '30007' count: 141 - reason: '30003' count: 58 top_failure_countries: - country: US count: 180 rate: 1.71 meta: request_id: req_9f2c1a7b timestamp: '2026-08-02T12:00:00.000Z' components: securitySchemes: Bearer: type: http scheme: bearer bearerFormat: JWT description: Dashboard JWT token from Clerk ApiKey: type: apiKey name: X-API-Key in: header description: Server-to-server API key (dv_live_sk_*) ````