> ## Documentation Index
> Fetch the complete documentation index at: https://knowledge.flowella.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Outbound message analytics

> Aggregates outbound message counts and rates by status for a date range.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/analytics
openapi: 3.0.0
info:
  title: Flowella REST API
  version: 2.1.0
  description: >-
    Public v1 HTTP API for Flowella. Authenticate with `Authorization: Bearer
    <api_key>` (`flo_` prefix). Canonical base: `https://api.flowella.io/v1`.
    Legacy `https://app.flowella.io/api/v1/...` requests are permanently
    redirected (308) to the canonical host, preserving method and body.
servers:
  - url: https://api.flowella.io
    description: Canonical API host
  - url: https://app.flowella.io
    description: Legacy app host — /api/v1 permanently redirects (308) to the API host /v1
security: []
tags:
  - name: System
    description: Health and auth checks
  - name: Messages
    description: Send WhatsApp messages
  - name: Conversations
    description: Inbox conversations
  - name: Contacts
    description: CRM contacts
  - name: Templates
    description: WhatsApp templates and bulk send
  - name: Analytics
    description: Usage and delivery metrics
paths:
  /v1/analytics:
    get:
      tags:
        - Analytics
      summary: Outbound message analytics
      description: Aggregates outbound message counts and rates by status for a date range.
      operationId: v1AnalyticsOutbound
      parameters:
        - schema:
            type: string
            nullable: true
          required: false
          name: startDate
          in: query
        - schema:
            type: string
            nullable: true
          required: false
          name: endDate
          in: query
      responses:
        '200':
          description: Analytics for period
          content:
            application/json:
              schema:
                type: object
                properties:
                  period:
                    type: object
                    properties:
                      start:
                        type: string
                      end:
                        type: string
                    required:
                      - start
                      - end
                  outboundMessages:
                    type: object
                    properties:
                      total:
                        type: integer
                        minimum: 0
                      counts:
                        type: object
                        properties:
                          PENDING:
                            type: integer
                            minimum: 0
                          SENT:
                            type: integer
                            minimum: 0
                          DELIVERED:
                            type: integer
                            minimum: 0
                          READ:
                            type: integer
                            minimum: 0
                          FAILED:
                            type: integer
                            minimum: 0
                      deliveryRate:
                        type: number
                      readRate:
                        type: number
                      failureRate:
                        type: number
                    required:
                      - total
                      - counts
                      - deliveryRate
                      - readRate
                      - failureRate
                required:
                  - period
                  - outboundMessages
                example:
                  period:
                    start: '2025-01-01T00:00:00.000Z'
                    end: '2025-02-01T00:00:00.000Z'
                  outboundMessages:
                    total: 42
                    counts:
                      PENDING: 0
                      SENT: 10
                      DELIVERED: 20
                      READ: 10
                      FAILED: 2
                    deliveryRate: 0.85
                    readRate: 0.33
                    failureRate: 0.05
        '400':
          description: Invalid range
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                    required:
                      - code
                      - message
                required:
                  - error
                example:
                  error:
                    code: UNAUTHORIZED
                    message: Invalid API key
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                    required:
                      - code
                      - message
                required:
                  - error
                example:
                  error:
                    code: UNAUTHORIZED
                    message: Invalid API key
        '402':
          description: Payment required
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                    required:
                      - code
                      - message
                required:
                  - error
                example:
                  error:
                    code: UNAUTHORIZED
                    message: Invalid API key
        '429':
          description: Rate limited
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                    required:
                      - code
                      - message
                required:
                  - error
                example:
                  error:
                    code: UNAUTHORIZED
                    message: Invalid API key
      security:
        - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API key
      description: >-
        Organization API key (`flo_…`). Paste the full key; Scalar sends
        `Authorization: Bearer <key>`.

````