AWeber · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for AWeber Campaigns API

6 actions 6 updates phrasing extends openapi/aweber-campaigns-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for AWeber's API. It is a proposal applied on top of the contract, not a document AWeber publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info

$.paths['/accounts/{accountId}/lists/{listId}/campaigns'].get

$.paths['/accounts/{accountId}/lists/{listId}/campaigns/{campaignType}{campaignId}'].get

$.paths['/accounts/{accountId}/lists/{listId}/campaigns?ws.op=find'].get

$.paths['/accounts/{accountId}/lists/{listId}/campaigns/b{campaignId}/stats'].get

$.paths['/accounts/{accountId}/lists/{listId}/campaigns/b{campaignId}/stats/{statsId}'].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 AWeber Campaigns API
  version: 1.0.0
extends: openapi/aweber-campaigns-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-02'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/accounts/{accountId}/lists/{listId}/campaigns'].get
  update:
    x-apievangelist-phrasing:
      intent: List all campaigns on a list
      effect: read
      questions:
      - What followup and broadcast campaigns exist on my list?
      - In what order are followups and broadcasts returned when I list every campaign?
      instructions:
      - text: List all followup and broadcast campaigns on list {listId} in account {accountId}.
        slots:
          listId: path.listId
          accountId: path.accountId
      - text: Show {size} campaigns of any type for list {listId}, account {accountId}, starting at {start}.
        slots:
          size: query.ws.size
          listId: path.listId
          accountId: path.accountId
          start: query.ws.start
      method: generated
      generated: '2026-10-02'
- target: $.paths['/accounts/{accountId}/lists/{listId}/campaigns/{campaignType}{campaignId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one followup or broadcast campaign
      effect: read
      questions:
      - Can I pull up a single followup message by its campaign ID?
      - What details does one specific campaign record hold?
      instructions:
      - text: Show campaign {campaignType}{campaignId} on list {listId} in account {accountId}.
        slots:
          campaignType: path.campaignType
          campaignId: path.campaignId
          listId: path.listId
          accountId: path.accountId
      - text: Get the {campaignType} campaign with ID {campaignId} from list {listId}, account {accountId}.
        slots:
          campaignType: path.campaignType
          campaignId: path.campaignId
          listId: path.listId
          accountId: path.accountId
      method: generated
      generated: '2026-10-02'
- target: $.paths['/accounts/{accountId}/lists/{listId}/campaigns?ws.op=find'].get
  update:
    x-apievangelist-phrasing:
      intent: Find campaigns of one type
      effect: read
      questions:
      - Can I filter my list's campaigns to only followups or only broadcasts?
      - Is there a way to get just the count of broadcast campaigns rather than the records?
      instructions:
      - text: Find only the {campaign_type} campaigns on list {listId} in account {accountId}.
        slots:
          campaign_type: query.campaign_type
          listId: path.listId
          accountId: path.accountId
      - text: Return the {show} of {campaign_type}-type campaigns for list {listId}, account {accountId}.
        slots:
          show: query.ws.show
          campaign_type: query.campaign_type
          listId: path.listId
          accountId: path.accountId
      method: generated
      generated: '2026-10-02'
- target: $.paths['/accounts/{accountId}/lists/{listId}/campaigns/b{campaignId}/stats'].get
  update:
    x-apievangelist-phrasing:
      intent: List statistics for a broadcast campaign
      effect: read
      questions:
      - What performance statistics are available for a sent broadcast campaign?
      - How do I see all the stats for a broadcast, like opens and clicks totals?
      instructions:
      - text: List all statistics for broadcast campaign {campaignId} on list {listId} in account {accountId}.
        slots:
          campaignId: path.campaignId
          listId: path.listId
          accountId: path.accountId
      - text: Page through {size} stats for broadcast campaign {campaignId}, list {listId}, account {accountId}.
        slots:
          size: query.ws.size
          campaignId: path.campaignId
          listId: path.listId
          accountId: path.accountId
      method: generated
      generated: '2026-10-02'
- target: $.paths['/accounts/{accountId}/lists/{listId}/campaigns/b{campaignId}/stats/{statsId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one statistic for a broadcast campaign
      effect: read
      questions:
      - Can I read a single named statistic for a broadcast instead of the whole set?
      - What value does one specific broadcast stat ID hold?
      instructions:
      - text: Get statistic {statsId} for broadcast campaign {campaignId} on list {listId} in account {accountId}.
        slots:
          statsId: path.statsId
          campaignId: path.campaignId
          listId: path.listId
          accountId: path.accountId
      - text: Show just the {statsId} stat of broadcast {campaignId}, list {listId}, account {accountId}.
        slots:
          statsId: path.statsId
          campaignId: path.campaignId
          listId: path.listId
          accountId: path.accountId
      method: generated
      generated: '2026-10-02'