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

# SMS analytics

> Totals and per-campaign results for a period.

Scope: `sms:read`.



## OpenAPI

````yaml /openapi.json get /sms/analytics
openapi: 3.1.0
info:
  title: Messaly API
  version: 1.0.0
  description: >-
    SMS, WhatsApp, email, contacts and CRM for your business. Amounts are in
    KES. Authenticate with an API key (Settings → API keys). A key can be
    limited to scopes and to IP addresses; a key with no scopes can call every
    endpoint here.
servers:
  - url: https://app.telaven.com/api/v1
    description: Production
security:
  - bearerAuth: []
  - apiKeyHeader: []
tags:
  - name: Account
    description: Wallet balance and SMS pricing.
  - name: SMS
    description: Send SMS and read messages and analytics.
  - name: SMS campaigns
    description: Create, schedule and send SMS campaigns to lists and tags.
  - name: Contacts
    description: Contacts and contact lists.
  - name: WhatsApp
    description: Send approved WhatsApp templates.
  - name: Email
    description: Email campaigns and unsubscribes.
  - name: CRM
    description: Deals, companies and pipelines.
paths:
  /sms/analytics:
    get:
      tags:
        - SMS
      summary: SMS analytics
      description: |-
        Totals and per-campaign results for a period.

        Scope: `sms:read`.
      operationId: smsAnalytics
      parameters:
        - name: days
          in: query
          required: false
          description: Last N days (1–365, default 30).
          schema:
            type: integer
            example: 30
        - name: from
          in: query
          required: false
          description: Start date (YYYY-MM-DD). Overrides `days`.
          schema:
            type: string
            format: date
        - name: to
          in: query
          required: false
          description: End date (YYYY-MM-DD).
          schema:
            type: string
            format: date
        - name: all
          in: query
          required: false
          description: '`true` for all time.'
          schema:
            type: boolean
      responses:
        '200':
          description: Success
          content:
            application/json:
              example:
                success: true
                data:
                  summary:
                    totalCampaigns: 14
                    completedCampaigns: 13
                    totalSent: 1240
                    totalDelivered: 1188
                    totalFailed: 12
                    totalQueued: 0
                    deliveryRate: 96
                    totalCost: 1116
                    avgCostPerSms: 0.9
                    totalContacts: 2400
                    totalLists: 3
                  dailyVolume: []
                  statusDistribution: []
                  campaignBreakdown: []
                  pagination:
                    page: 1
                    limit: 10
                    total: 14
                    totalPages: 2
        '401':
          description: No API key, or the key is wrong, disabled or expired.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: >-
            The key doesn't have the scope this endpoint needs, or it's used
            from an address its IP allowlist doesn't include.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: >-
            More than 120 requests in a minute with this key. Wait for the
            number of seconds in Retry-After.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: >-
            Something went wrong on our side. Retry with backoff. A POST sent
            with an Idempotency-Key replays this same error for that key,
            because the request may have partly run: check the result before
            trying again with a new key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: string
        code:
          type: string
          description: Machine-readable code where one exists, e.g. INSUFFICIENT_BALANCE.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Authorization: Bearer tlv_…'
    apiKeyHeader:
      type: apiKey
      in: header
      name: X-API-Key

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.