ActiveCampaign · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Partners CRM Reporting API

3 actions 3 updates phrasing extends openapi/activecampaign-crm-reporting-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 3

$.info

$.paths['/api/crm-reporting/v1/pipelines'].get

$.paths['/api/crm-reporting/v1/pipelines/summary'].get

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Partners CRM Reporting API
  version: 1.0.0
extends: openapi/activecampaign-crm-reporting-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: 2
- target: $.paths['/api/crm-reporting/v1/pipelines'].get
  update:
    x-apievangelist-phrasing:
      intent: Report on each sales pipeline
      effect: read
      questions:
      - Which pipelines brought in the most revenue this quarter?
      - What is the conversion rate and top account for each of my deal pipelines?
      - Can I search the pipeline report by name and page through results?
      instructions:
      - text: List pipelines with deal counts and revenue from {start_date} to {end_date}.
        slots:
          start_date: query.start_date
          end_date: query.end_date
      - text: Show per-pipeline conversion for {start_date} to {end_date} in timezone {timezone}.
        slots:
          start_date: query.start_date
          end_date: query.end_date
          timezone: query.timezone
      - text: Find pipelines matching {search} with stats between {start_date} and {end_date}.
        slots:
          search: query.search
          start_date: query.start_date
          end_date: query.end_date
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/crm-reporting/v1/pipelines/summary'].get
  update:
    x-apievangelist-phrasing:
      intent: Summarize deal metrics across pipelines
      effect: read
      questions:
      - What is my total deal revenue and average deal size for a period?
      - How many deals did we win overall between two dates?
      instructions:
      - text: Give me the overall pipeline summary cards from {start_date} to {end_date}.
        slots:
          start_date: query.start_date
          end_date: query.end_date
      - text: Summarize total revenue and conversion from {start_date} to {end_date} in {timezone}.
        slots:
          start_date: query.start_date
          end_date: query.end_date
          timezone: query.timezone
      method: generated
      generated: '2026-09-26'