ActiveCampaign

ActiveCampaign Metrics API

The Metrics API from ActiveCampaign — 5 operation(s) for metrics.

GitHub OpenAPI

Documentation

📖
Documentation
https://developers.activecampaign.com/reference/overview
📖
Authentication
https://developers.activecampaign.com/reference/authentication

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/activecampaign/refs/heads/main/openapi/activecampaign-metrics-api-openapi.yml
⚙
AsyncAPI
https://raw.githubusercontent.com/api-evangelist/activecampaign/refs/heads/main/asyncapi/activecampaign-webhooks-asyncapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/activecampaign/refs/heads/main/json-schema/activecampaign-sms-broadcast-message-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/activecampaign/refs/heads/main/json-schema/activecampaign-sms-broadcast-create-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/activecampaign/refs/heads/main/json-schema/activecampaign-sms-broadcast-update-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/activecampaign/refs/heads/main/json-schema/activecampaign-sms-broadcast-metrics-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/activecampaign/refs/heads/main/json-schema/activecampaign-sms-recipient-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/activecampaign/refs/heads/main/json-schema/activecampaign-sms-credits-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/activecampaign/refs/heads/main/json-schema/activecampaign-sms-ai-broadcast-request-schema.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/activecampaign/refs/heads/main/json-structure/activecampaign-sms-broadcast-message-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/activecampaign/refs/heads/main/json-structure/activecampaign-sms-recipient-structure.json

Other Resources

🔗
GraphQL
https://raw.githubusercontent.com/api-evangelist/activecampaign/refs/heads/main/graphql/activecampaign-graphql.md
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/activecampaign/refs/heads/main/examples/activecampaign-sms-broadcast-message-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/activecampaign/refs/heads/main/examples/activecampaign-sms-recipient-example.json

OpenAPI Specification

activecampaign-metrics-api-openapi.yml Raw ↑ 
openapi: 3.0.3
info:
  title: ActiveCampaign SMS Broadcast Accounts Metrics 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: Metrics
paths:
  /sms/broadcasts/metrics:
    post:
      tags:
      - Metrics
      summary: ActiveCampaign Get All Broadcast Metrics
      description: Returns metrics for specified broadcast IDs
      operationId: getBroadcastMetrics
      parameters:
      - name: start_date
        in: query
        description: Start date for metrics (YYYY-MM-DD)
        schema:
          type: string
          format: date
      - name: end_date
        in: query
        description: End date for metrics (YYYY-MM-DD)
        schema:
          type: string
          format: date
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                ids:
                  type: array
                  items:
                    type: integer
      responses:
        '200':
          description: Metrics retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BroadcastMetricsResponse'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /sms/broadcasts/metrics/snapshot:
    get:
      tags:
      - Metrics
      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:
      - Metrics
      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
  /sms/broadcasts/metrics/{broadcastId}/failures:
    get:
      tags:
      - Metrics
      summary: ActiveCampaign Get Broadcast Failure Details
      description: Returns grouping and counts of failures for the broadcast
      operationId: getBroadcastFailures
      parameters:
      - name: broadcastId
        in: path
        required: true
        description: Broadcast ID
        schema:
          type: integer
      - name: start_date
        in: query
        description: Start date (YYYY-MM-DD)
        schema:
          type: string
          format: date
      - name: end_date
        in: query
        description: End date (YYYY-MM-DD)
        schema:
          type: string
          format: date
      responses:
        '200':
          description: Failure details retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FailureDetailsResponse'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /sms/broadcasts/export:
    post:
      tags:
      - Metrics
      summary: ActiveCampaign Export Broadcast Metrics
      description: Export broadcast performance metrics as CSV
      operationId: exportBroadcastMetrics
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                ids:
                  type: array
                  items:
                    type: integer
      responses:
        '200':
          description: Export generated successfully
          content:
            text/csv:
              schema:
                type: string
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /sms/broadcasts/{broadcastId}/recipients/export:
    post:
      tags:
      - Metrics
      summary: ActiveCampaign Export Broadcast Recipients
      description: Export recipient data as CSV including full contact records
      operationId: exportBroadcastRecipients
      parameters:
      - name: broadcastId
        in: path
        required: true
        description: Broadcast ID
        schema:
          type: integer
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                start_date:
                  type: string
                  format: date
                end_date:
                  type: string
                  format: date
                engagement:
                  type: array
                  items:
                    type: string
                deliverability:
                  type: array
                  items:
                    type: string
                search:
                  type: string
                order:
                  type: object
      responses:
        '200':
          description: Export generated successfully
          content:
            text/csv:
              schema:
                type: string
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    FailureDetail:
      type: object
      properties:
        errorCode:
          type: string
        errorSource:
          type: string
          enum:
          - ac
          - twilio
        count:
          type: integer
    BroadcastMetricsResponse:
      type: object
      properties:
        metrics:
          type: array
          items:
            $ref: '#/components/schemas/BroadcastMetrics'
    FailureDetailsResponse:
      type: object
      properties:
        failures:
          type: array
          items:
            $ref: '#/components/schemas/FailureDetail'
    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
    BroadcastMetrics:
      type: object
      properties:
        id:
          type: integer
        sends:
          type: integer
        deliveries:
          type: integer
        replies:
          type: integer
        failures:
          type: integer
        optOuts:
          type: integer
        clicks:
          type: integer
  securitySchemes:
    ApiToken:
      type: apiKey
      name: Api-Token
      in: header
      description: Your ActiveCampaign API token