ActiveCampaign · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for ActiveCampaign SMS Broadcast Metrics API

5 actions 5 updates phrasing extends openapi/activecampaign-metrics-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for ActiveCampaign's API. It is a proposal applied on top of the contract, not a document ActiveCampaign publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/sms/broadcasts/metrics'].post
$.paths['/sms/broadcasts/metrics/snapshot'].get
$.paths['/sms/broadcasts/metrics/snapshot'].post
$.paths['/sms/broadcasts/export'].post

OpenAPI Overlay

Raw ↑ 
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for ActiveCampaign SMS Broadcast Metrics API
  version: 1.0.0
extends: openapi/activecampaign-metrics-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 4
- target: $.paths['/sms/broadcasts/metrics'].post
  update:
    x-apievangelist-phrasing:
      intent: Get metrics for specific SMS broadcasts
      effect: read
      questions:
      - How did my SMS broadcasts perform over a given date range?
      - Can I pull delivery and click metrics for just a few SMS broadcasts by ID?
      instructions:
      - text: Get metrics for SMS broadcasts {ids}.
        slots:
          ids: requestBody.ids
      - text: Get metrics for SMS broadcasts {ids} between {start_date} and {end_date}.
        slots:
          ids: requestBody.ids
          start_date: query.start_date
          end_date: query.end_date
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sms/broadcasts/metrics/snapshot'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a snapshot of all SMS broadcasts
      effect: read
      questions:
      - What is the overall summary of all my SMS broadcasts for last month?
      - Can I get a snapshot across every SMS broadcast in a date window?
      instructions:
      - text: Show a snapshot of all SMS broadcasts.
      - text: Summarize all SMS broadcasts from {start_date} to {end_date}.
        slots:
          start_date: query.start_date
          end_date: query.end_date
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sms/broadcasts/metrics/snapshot'].post
  update:
    x-apievangelist-phrasing:
      intent: Get a snapshot for chosen SMS broadcasts
      effect: read
      questions:
      - Can I get the summary snapshot for only selected SMS broadcasts?
      - Which call gives snapshot data when I pass a list of broadcast IDs?
      instructions:
      - text: Get the snapshot summary for SMS broadcasts {ids}.
        slots:
          ids: requestBody.ids
      - text: 'Show snapshot totals for just these broadcasts: {ids}.'
        slots:
          ids: requestBody.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sms/broadcasts/export'].post
  update:
    x-apievangelist-phrasing:
      intent: Export SMS broadcast metrics as CSV
      effect: read
      questions:
      - How do I download SMS broadcast performance as a CSV file?
      - Can I export metrics for several SMS broadcasts to a spreadsheet?
      instructions:
      - text: Export metrics for SMS broadcasts {ids} as CSV.
        slots:
          ids: requestBody.ids
      - text: Give me a CSV of broadcast performance for {ids}.
        slots:
          ids: requestBody.ids
      method: generated
      generated: '2026-09-26'