Impact · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Agency Advertisers API

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

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/Agencies/{AccountSID}/Advertisers'].get
$.paths['/Agencies/{AccountSID}/Advertisers/{AdvertiserId}'].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 Agency Advertisers API
  version: 1.0.0
extends: openapi/impact-advertisers-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['/Agencies/{AccountSID}/Advertisers'].get
  update:
    x-apievangelist-phrasing:
      intent: List an agency's advertisers
      effect: read
      questions:
      - Which advertisers does my agency manage on impact.com?
      - Can I get billing and contact details for all my agency's advertisers at once?
      instructions:
      - text: List all advertisers under agency account {sid}.
        slots:
          sid: path.AccountSID
      - text: Show every brand my agency {sid} manages.
        slots:
          sid: path.AccountSID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Agencies/{AccountSID}/Advertisers/{AdvertiserId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one advertiser my agency manages
      effect: read
      questions:
      - What are the full account details for one advertiser I manage?
      - Can I look up a single advertiser by its numeric ID?
      instructions:
      - text: Get advertiser {adv} under agency account {sid}.
        slots:
          sid: path.AccountSID
          adv: path.AdvertiserId
      - text: Show the account details of managed advertiser {adv}.
        slots:
          adv: path.AdvertiserId
      method: generated
      generated: '2026-09-26'