> ## 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.

# Get campaign summary counts

> Return tenant-wide campaign counts for the dashboard header — the total number of campaigns, how many are active now, how many are scheduled, lifetime sent/delivered/failed totals, and a per-status breakdown that drives the status-tab badges. Optionally scope the counts with the same channel/search/type filters the campaign list uses so the badges match the rows beneath them.



## OpenAPI

````yaml /openapi.yaml get /api/v1/campaigns/stats
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/campaigns/stats:
    get:
      tags:
        - Campaigns
      summary: Get campaign summary counts
      description: >-
        Return tenant-wide campaign counts for the dashboard header — the total
        number of campaigns, how many are active now, how many are scheduled,
        lifetime sent/delivered/failed totals, and a per-status breakdown that
        drives the status-tab badges. Optionally scope the counts with the same
        channel/search/type filters the campaign list uses so the badges match
        the rows beneath them.
      parameters:
        - schema:
            type: string
          in: query
          name: search
          required: false
          description: >-
            Free-text filter applied to campaign name/description, matching the
            campaign list.
        - schema:
            type: string
          in: query
          name: channel
          required: false
          description: >-
            Restrict the counts to a single channel (e.g. `sms`, `email`,
            `whatsapp`).
        - schema:
            type: string
          in: query
          name: type
          required: false
          description: >-
            Restrict the counts to a campaign type (e.g. `blast`, `drip`,
            `journey`).
      responses:
        '200':
          description: Aggregate campaign counts for the tenant
          content:
            application/json:
              schema:
                type: object
                description: Aggregate campaign counts for the tenant
                properties:
                  data:
                    type: object
                    properties:
                      total:
                        type: integer
                        description: Total number of campaigns matching the filters.
                      running:
                        type: integer
                        description: >-
                          Campaigns the operator sees as live now (running +
                          aborting + sending).
                      scheduled:
                        type: integer
                        description: Campaigns scheduled to send in the future.
                      totalSent:
                        type: integer
                      totalDelivered:
                        type: integer
                      totalFailed:
                        type: integer
                      by_status:
                        type: object
                        additionalProperties:
                          type: integer
                        description: >-
                          Count of campaigns per lifecycle status; absent keys
                          mean zero.
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        description: >-
                          Unique request identifier (also returned in
                          X-Request-Id header)
                      timestamp:
                        type: string
                        format: date-time
                        description: ISO 8601 UTC timestamp of the response
              example:
                data:
                  total: 42
                  running: 3
                  scheduled: 5
                  totalSent: 128450
                  totalDelivered: 121002
                  totalFailed: 3120
                  by_status:
                    draft: 12
                    scheduled: 5
                    running: 3
                    completed: 20
                    paused: 2
                meta:
                  request_id: req_7c1e9a2b3f
                  timestamp: '2026-08-02T14:23:11.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_*)

````