> ## 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. # Aggregate message delivery metrics with time-series > Returns headline messaging KPIs for the selected date range — total sent, delivered, failed and read, the derived delivery and read rates, and the average delivery time — plus a per-bucket (hour/day/week/month) time-series for charting. Powers the Reports page and the insights delivery-trend graph; filter by channel, status or campaign_id, and pass phone_number_id to scope the WhatsApp Quality tile to a single sending number. Read-only; degrades to zeroed totals and an empty time_series (still 200) during a transient database blip so the continuously-polled page never flashes a 5xx. ## OpenAPI ````yaml /openapi.yaml get /api/v1/analytics/messages 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/messages: get: tags: - Analytics summary: Aggregate message delivery metrics with time-series description: >- Returns headline messaging KPIs for the selected date range — total sent, delivered, failed and read, the derived delivery and read rates, and the average delivery time — plus a per-bucket (hour/day/week/month) time-series for charting. Powers the Reports page and the insights delivery-trend graph; filter by channel, status or campaign_id, and pass phone_number_id to scope the WhatsApp Quality tile to a single sending number. Read-only; degrades to zeroed totals and an empty time_series (still 200) during a transient database blip so the continuously-polled page never flashes a 5xx. parameters: - name: start_date in: query required: false schema: type: string format: date description: >- Inclusive start of the reporting window (ISO-8601 date or datetime). Defaults to the last 30 days when omitted; the range may not exceed the platform lookback cap. - name: end_date in: query required: false schema: type: string format: date description: >- Inclusive end of the reporting window (ISO-8601 date or datetime). A single-day range (start_date === end_date) is accepted. - name: days in: query required: false schema: type: integer minimum: 1 description: >- Alternative rolling lookback in whole days (bounded by the lookback cap). Mutually exclusive with an explicit start/end range. - name: channel in: query required: false schema: type: string description: >- Optional single-channel filter (e.g. sms, whatsapp, email, rcs, viber, telegram). - name: status in: query required: false schema: type: string description: Optional message-status filter (e.g. delivered, failed). - name: campaign_id in: query required: false schema: type: string description: Optional filter to a single campaign's messages. - name: group_by in: query required: false schema: type: string enum: - hour - day - week - month default: day description: Time-series bucket granularity. - name: phone_number_id in: query required: false schema: type: string description: >- Optional WhatsApp multi-WABA scope — narrows the time-series to outbound rows stamped with this sending phone_number_id. responses: '200': description: >- Aggregate delivery totals plus the bucketed time-series for the window. content: application/json: schema: type: object properties: data: type: object properties: totals: type: object properties: total_sent: type: integer total_delivered: type: integer total_failed: type: integer total_read: type: integer delivery_rate: type: number description: Delivered / sent, 0–100. read_rate: type: number description: Read / delivered, 0–100. avg_delivery_time_ms: type: number time_series: type: array items: type: object properties: period: type: string format: date-time period_date: type: string format: date description: Tenant-local calendar date of the bucket. total_sent: type: integer total_delivered: type: integer total_failed: type: integer total_read: type: integer delivery_rate: type: number read_rate: type: number avg_delivery_time_ms: type: number group_by: type: string meta: type: object properties: request_id: type: string timestamp: type: string format: date-time example: data: totals: total_sent: 17150 total_delivered: 16899 total_failed: 251 total_read: 12042 delivery_rate: 98.54 read_rate: 71.26 avg_delivery_time_ms: 1840 time_series: - period: '2026-08-01T00:00:00.000Z' period_date: '2026-08-01' total_sent: 2450 total_delivered: 2416 total_failed: 34 total_read: 1720 delivery_rate: 98.61 read_rate: 71.19 avg_delivery_time_ms: 1795 group_by: day 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_*) ````