ActiveCampaign SMS Broadcast API — Metrics

naftiko: 1.0.0-alpha2
info:
  label: ActiveCampaign SMS Broadcast API — Metrics
  description: 'ActiveCampaign SMS Broadcast API — Metrics. 6 operations. Lead operation: ActiveCampaign Export Broadcast
    Metrics. Self-contained Naftiko capability covering one Activecampaign business surface.'
  tags:
  - Activecampaign
  - Metrics
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    ACTIVECAMPAIGN_API_KEY: ACTIVECAMPAIGN_API_KEY
capability:
  consumes:
  - type: http
    namespace: sms-metrics
    baseUri: https://{yourAccountName}.api-us1.com/api/3
    description: ActiveCampaign SMS Broadcast API — Metrics business capability. Self-contained, no shared references.
    resources:
    - name: sms-broadcasts-export
      path: /sms/broadcasts/export
      operations:
      - name: exportbroadcastmetrics
        method: POST
        description: ActiveCampaign Export Broadcast Metrics
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: sms-broadcasts-metrics
      path: /sms/broadcasts/metrics
      operations:
      - name: getbroadcastmetrics
        method: POST
        description: ActiveCampaign Get All Broadcast Metrics
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: start_date
          in: query
          type: string
          description: Start date for metrics (YYYY-MM-DD)
        - name: end_date
          in: query
          type: string
          description: End date for metrics (YYYY-MM-DD)
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: sms-broadcasts-metrics-snapshot
      path: /sms/broadcasts/metrics/snapshot
      operations:
      - name: getbroadcastsnapshot
        method: GET
        description: ActiveCampaign Get Broadcast Snapshot
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: start_date
          in: query
          type: string
          description: Start date for snapshot (YYYY-MM-DD)
        - name: end_date
          in: query
          type: string
          description: End date for snapshot (YYYY-MM-DD)
      - name: getbroadcastsnapshotbyids
        method: POST
        description: ActiveCampaign Get Broadcast Snapshot
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: sms-broadcasts-metrics-broadcastId-failures
      path: /sms/broadcasts/metrics/{broadcastId}/failures
      operations:
      - name: getbroadcastfailures
        method: GET
        description: ActiveCampaign Get Broadcast Failure Details
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: broadcastId
          in: path
          type: integer
          description: Broadcast ID
          required: true
        - name: start_date
          in: query
          type: string
          description: Start date (YYYY-MM-DD)
        - name: end_date
          in: query
          type: string
          description: End date (YYYY-MM-DD)
    - name: sms-broadcasts-broadcastId-recipients-export
      path: /sms/broadcasts/{broadcastId}/recipients/export
      operations:
      - name: exportbroadcastrecipients
        method: POST
        description: ActiveCampaign Export Broadcast Recipients
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: broadcastId
          in: path
          type: integer
          description: Broadcast ID
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: apikey
      key: Api-Token
      value: '{{env.ACTIVECAMPAIGN_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: sms-metrics-rest
    port: 8080
    description: REST adapter for ActiveCampaign SMS Broadcast API — Metrics. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/sms/broadcasts/export
      name: sms-broadcasts-export
      description: REST surface for sms-broadcasts-export.
      operations:
      - method: POST
        name: exportbroadcastmetrics
        description: ActiveCampaign Export Broadcast Metrics
        call: sms-metrics.exportbroadcastmetrics
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/sms/broadcasts/metrics
      name: sms-broadcasts-metrics
      description: REST surface for sms-broadcasts-metrics.
      operations:
      - method: POST
        name: getbroadcastmetrics
        description: ActiveCampaign Get All Broadcast Metrics
        call: sms-metrics.getbroadcastmetrics
        with:
          start_date: rest.start_date
          end_date: rest.end_date
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/sms/broadcasts/metrics/snapshot
      name: sms-broadcasts-metrics-snapshot
      description: REST surface for sms-broadcasts-metrics-snapshot.
      operations:
      - method: GET
        name: getbroadcastsnapshot
        description: ActiveCampaign Get Broadcast Snapshot
        call: sms-metrics.getbroadcastsnapshot
        with:
          start_date: rest.start_date
          end_date: rest.end_date
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: getbroadcastsnapshotbyids
        description: ActiveCampaign Get Broadcast Snapshot
        call: sms-metrics.getbroadcastsnapshotbyids
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/sms/broadcasts/metrics/{broadcastid}/failures
      name: sms-broadcasts-metrics-broadcastid-failures
      description: REST surface for sms-broadcasts-metrics-broadcastId-failures.
      operations:
      - method: GET
        name: getbroadcastfailures
        description: ActiveCampaign Get Broadcast Failure Details
        call: sms-metrics.getbroadcastfailures
        with:
          broadcastId: rest.broadcastId
          start_date: rest.start_date
          end_date: rest.end_date
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/sms/broadcasts/{broadcastid}/recipients/export
      name: sms-broadcasts-broadcastid-recipients-export
      description: REST surface for sms-broadcasts-broadcastId-recipients-export.
      operations:
      - method: POST
        name: exportbroadcastrecipients
        description: ActiveCampaign Export Broadcast Recipients
        call: sms-metrics.exportbroadcastrecipients
        with:
          broadcastId: rest.broadcastId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: sms-metrics-mcp
    port: 9090
    transport: http
    description: MCP adapter for ActiveCampaign SMS Broadcast API — Metrics. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: activecampaign-export-broadcast-metrics
      description: ActiveCampaign Export Broadcast Metrics
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: sms-metrics.exportbroadcastmetrics
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: activecampaign-get-all-broadcast-metrics
      description: ActiveCampaign Get All Broadcast Metrics
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: sms-metrics.getbroadcastmetrics
      with:
        start_date: tools.start_date
        end_date: tools.end_date
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: activecampaign-get-broadcast-snapshot
      description: ActiveCampaign Get Broadcast Snapshot
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: sms-metrics.getbroadcastsnapshot
      with:
        start_date: tools.start_date
        end_date: tools.end_date
      outputParameters:
      - type: object
        mapping: $.
    - name: activecampaign-get-broadcast-snapshot-2
      description: ActiveCampaign Get Broadcast Snapshot
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: sms-metrics.getbroadcastsnapshotbyids
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: activecampaign-get-broadcast-failure-details
      description: ActiveCampaign Get Broadcast Failure Details
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: sms-metrics.getbroadcastfailures
      with:
        broadcastId: tools.broadcastId
        start_date: tools.start_date
        end_date: tools.end_date
      outputParameters:
      - type: object
        mapping: $.
    - name: activecampaign-export-broadcast-recipients
      description: ActiveCampaign Export Broadcast Recipients
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: sms-metrics.exportbroadcastrecipients
      with:
        broadcastId: tools.broadcastId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.