openapi: 3.0.3
info:
  title: ActiveCampaign SMS Broadcast Accounts Snapshots API
  description: API for managing SMS broadcasts, lists, metrics, and AI-powered content generation in ActiveCampaign
  version: 3.0.0
  contact:
    name: ActiveCampaign Support
    url: https://www.activecampaign.com
  x-generated-from: documentation
servers:
- url: https://{yourAccountName}.api-us1.com/api/3
  description: US-based Users
  variables:
    yourAccountName:
      default: yourAccountName
security:
- ApiToken: []
tags:
- name: Snapshots
paths:
  /sms/broadcasts/metrics/snapshot:
    get:
      tags:
      - Snapshots
      summary: ActiveCampaign Get Broadcast Snapshot
      description: Returns snapshot data for all broadcasts
      operationId: getBroadcastSnapshot
      parameters:
      - name: start_date
        in: query
        description: Start date for snapshot (YYYY-MM-DD)
        schema:
          type: string
          format: date
      - name: end_date
        in: query
        description: End date for snapshot (YYYY-MM-DD)
        schema:
          type: string
          format: date
      responses:
        '200':
          description: Snapshot retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SnapshotResponse'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      tags:
      - Snapshots
      summary: ActiveCampaign Get Broadcast Snapshot
      description: Returns snapshot for specified broadcast IDs
      operationId: getBroadcastSnapshotByIds
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                ids:
                  type: array
                  items:
                    type: integer
      responses:
        '200':
          description: Snapshot retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SnapshotResponse'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    SnapshotResponse:
      type: object
      properties:
        snapshot:
          type: object
          properties:
            campaigns:
              type: integer
            sends:
              type: integer
            deliveries:
              type: integer
            clicks:
              type: integer
            replies:
              type: integer
            failures:
              type: integer
            optOuts:
              type: integer
  securitySchemes:
    ApiToken:
      type: apiKey
      name: Api-Token
      in: header
      description: Your ActiveCampaign API token