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

# Get campaign analytics for organization

> Returns aggregate campaign analytics for the authenticated user organization: total campaigns, status breakdown (scheduled/sent/failed/partial/cancelled), segmented campaign counts, and per-message totals with overall success rate.



## OpenAPI

````yaml /api-reference/openapi.yaml get /api/campaigns/analytics
openapi: 3.0.3
info:
  title: Tether Relay and Tether API
  version: 1.0.0
  description: >-
    Route-derived OpenAPI contract generated from tether-relay backend sources.
    Regenerate with scripts/sync-openapi-from-backend.mjs.
servers:
  - url: https://your-instance.example.com
    description: Production
  - url: http://localhost:2212
    description: Local API service
security: []
tags:
  - name: AI
  - name: Applications
  - name: Approval
  - name: Auth
  - name: Automations
  - name: Calls
  - name: Campaigns
  - name: Contact Analytics
  - name: Contact Metrics
  - name: Contact Notes
  - name: Contacts
  - name: Conversation Monitor
  - name: Conversations
  - name: Departments
  - name: Email
  - name: Escalation Dashboard
  - name: Event Logs
  - name: Google Sheets
  - name: Marketplace
  - name: Messages
  - name: Notification Sounds
  - name: Notifications
  - name: Org Snapshots
  - name: Organizations
  - name: Outreach
  - name: Outreach Metrics
  - name: Outreach Sources
  - name: Pipelines
  - name: Processes
  - name: Prompts
  - name: Reminders
  - name: Sms
  - name: Templates
  - name: Traces
  - name: Training
  - name: Upload
  - name: User Snapshots
  - name: Users
  - name: Vertical
  - name: Webchats
  - name: Webhook
paths:
  /api/campaigns/analytics:
    get:
      tags:
        - Campaigns
      summary: Get campaign analytics for organization
      description: >-
        Returns aggregate campaign analytics for the authenticated user
        organization: total campaigns, status breakdown
        (scheduled/sent/failed/partial/cancelled), segmented campaign counts,
        and per-message totals with overall success rate.
      operationId: get_campaigns_analytics
      responses:
        '200':
          description: Analytics returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CampaignAnalyticsResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - bearerAuth: []
components:
  schemas:
    CampaignAnalyticsResponse:
      type: object
      properties:
        success:
          type: boolean
        data:
          type: object
          properties:
            totalCampaigns:
              type: integer
            scheduledCount:
              type: integer
            sentCount:
              type: integer
            failedCount:
              type: integer
            partialSuccessCount:
              type: integer
            cancelledCount:
              type: integer
            segmentedCount:
              type: integer
            segmentedPercentage:
              type: string
            totalMessages:
              type: integer
            sentMessages:
              type: integer
            scheduledMessages:
              type: integer
            failedMessages:
              type: integer
            overallSuccessRate:
              type: string
          additionalProperties: true
      additionalProperties: true
      example:
        success: true
        data:
          totalCampaigns: 42
          scheduledCount: 5
          sentCount: 30
          failedCount: 1
          partialSuccessCount: 4
          cancelledCount: 2
          segmentedCount: 8
          segmentedPercentage: 19.05%
          totalMessages: 12450
          sentMessages: 12380
          scheduledMessages: 50
          failedMessages: 20
          overallSuccessRate: 99.4%
    ErrorResponse:
      type: object
      properties:
        success:
          type: boolean
          enum:
            - false
        message:
          type: string
        error:
          type: string
      additionalProperties: true
      example:
        success: false
        message: Validation error
        error: name is required
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````