AWeber · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for AWeber Webforms API

9 actions 9 updates phrasing extends openapi/aweber-webforms-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 9

$.info
$.paths['/accounts/{accountId}?ws.op=getWebForms'].get
$.paths['/accounts/{accountId}?ws.op=getWebFormSplitTests'].get
$.paths['/accounts/{accountId}/lists/{listId}/web_forms'].get
$.paths['/accounts/{accountId}/lists/{listId}/web_forms/{webformId}'].get
$.paths['/accounts/{accountId}/lists/{listId}/web_form_split_tests'].get
$.paths['/accounts/{accountId}/lists/{listId}/web_form_split_tests/{splitTestId}'].get
$.paths['/accounts/{accountId}/lists/{listId}/web_form_split_tests/{splitTestId}/components'].get
$.paths['/accounts/{accountId}/lists/{listId}/web_form_split_tests/{splitTestId}/components/{splitTestComponentId}'].get

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 AWeber Webforms API
  version: 1.0.0
extends: openapi/aweber-webforms-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: 8
- target: $.paths['/accounts/{accountId}?ws.op=getWebForms'].get
  update:
    x-apievangelist-phrasing:
      intent: List webforms across all lists in an account
      effect: read
      questions:
      - Can I get every signup webform on my account at once, across all lists?
      - What webforms exist account-wide, not just on one list?
      instructions:
      - text: List webforms for all lists in account {accountId}, {size} at a time from {start}, via {op}.
        slots:
          accountId: path.accountId
          size: query.ws.size
          start: query.ws.start
          op: query.ws.op
      - text: Show every account-wide webform in account {accountId}, page size {size} from offset {start}, using {op}.
        slots:
          accountId: path.accountId
          size: query.ws.size
          start: query.ws.start
          op: query.ws.op
      method: generated
      generated: '2026-10-02'
- target: $.paths['/accounts/{accountId}?ws.op=getWebFormSplitTests'].get
  update:
    x-apievangelist-phrasing:
      intent: List webform split tests across an account
      effect: read
      questions:
      - Which webform split tests are running anywhere on my account?
      - Can I fetch A/B tests for signup forms across all lists in one call?
      instructions:
      - text: List webform split tests for all lists in account {accountId}, {size} from {start}, via {op}.
        slots:
          accountId: path.accountId
          size: query.ws.size
          start: query.ws.start
          op: query.ws.op
      - text: Show account-wide form A/B tests for account {accountId}, page size {size} from offset {start}, using {op}.
        slots:
          accountId: path.accountId
          size: query.ws.size
          start: query.ws.start
          op: query.ws.op
      method: generated
      generated: '2026-10-02'
- target: $.paths['/accounts/{accountId}/lists/{listId}/web_forms'].get
  update:
    x-apievangelist-phrasing:
      intent: List webforms on one list
      effect: read
      questions:
      - Which signup forms feed subscribers into one specific list?
      - How do I see only the webforms attached to a single list?
      instructions:
      - text: List the webforms on list {listId} in account {accountId}.
        slots:
          listId: path.listId
          accountId: path.accountId
      - text: Show {size} signup forms for list {listId}, account {accountId}.
        slots:
          size: query.ws.size
          listId: path.listId
          accountId: path.accountId
      method: generated
      generated: '2026-10-02'
- target: $.paths['/accounts/{accountId}/lists/{listId}/web_forms/{webformId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one webform on a list
      effect: read
      questions:
      - What are the details and stats of one particular signup form?
      - Can I look up a single webform by its ID?
      instructions:
      - text: Show webform {webformId} on list {listId} in account {accountId}.
        slots:
          webformId: path.webformId
          listId: path.listId
          accountId: path.accountId
      - text: Get the details of signup form {webformId} from list {listId}, account {accountId}.
        slots:
          webformId: path.webformId
          listId: path.listId
          accountId: path.accountId
      method: generated
      generated: '2026-10-02'
- target: $.paths['/accounts/{accountId}/lists/{listId}/web_form_split_tests'].get
  update:
    x-apievangelist-phrasing:
      intent: List webform split tests on one list
      effect: read
      questions:
      - What form split tests are set up on a single list?
      - Can I page through the A/B tests for one list's signup forms?
      instructions:
      - text: List the webform split tests on list {listId} in account {accountId}.
        slots:
          listId: path.listId
          accountId: path.accountId
      - text: Show {size} form A/B tests for list {listId}, account {accountId}.
        slots:
          size: query.ws.size
          listId: path.listId
          accountId: path.accountId
      method: generated
      generated: '2026-10-02'
- target: $.paths['/accounts/{accountId}/lists/{listId}/web_form_split_tests/{splitTestId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one webform split test
      effect: read
      questions:
      - What are the settings of one specific webform split test?
      - Can I fetch a single form A/B test by its ID?
      instructions:
      - text: Show split test {splitTestId} on list {listId} in account {accountId}.
        slots:
          splitTestId: path.splitTestId
          listId: path.listId
          accountId: path.accountId
      - text: Get the details of form A/B test {splitTestId} from list {listId}, account {accountId}.
        slots:
          splitTestId: path.splitTestId
          listId: path.listId
          accountId: path.accountId
      method: generated
      generated: '2026-10-02'
- target: $.paths['/accounts/{accountId}/lists/{listId}/web_form_split_tests/{splitTestId}/components'].get
  update:
    x-apievangelist-phrasing:
      intent: List the forms inside a split test
      effect: read
      questions:
      - Which webform variants are competing in my split test?
      - Can I see how traffic is divided among the forms in an A/B test?
      instructions:
      - text: List the components of split test {splitTestId} on list {listId} in account {accountId}.
        slots:
          splitTestId: path.splitTestId
          listId: path.listId
          accountId: path.accountId
      - text: Show every form variant in A/B test {splitTestId}, list {listId}, account {accountId}.
        slots:
          splitTestId: path.splitTestId
          listId: path.listId
          accountId: path.accountId
      method: generated
      generated: '2026-10-02'
- target: $.paths['/accounts/{accountId}/lists/{listId}/web_form_split_tests/{splitTestId}/components/{splitTestComponentId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one component of a split test
      effect: read
      questions:
      - What are the details of a single variant within a form split test?
      - Can I look up one split test component by its ID?
      instructions:
      - text: Show component {splitTestComponentId} of split test {splitTestId} on list {listId} in account {accountId}.
        slots:
          splitTestComponentId: path.splitTestComponentId
          splitTestId: path.splitTestId
          listId: path.listId
          accountId: path.accountId
      - text: Get variant {splitTestComponentId} from A/B test {splitTestId}, list {listId}, account {accountId}.
        slots:
          splitTestComponentId: path.splitTestComponentId
          splitTestId: path.splitTestId
          listId: path.listId
          accountId: path.accountId
      method: generated
      generated: '2026-10-02'