Impact · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Impact Clicks API

3 actions 3 updates phrasing extends openapi/impact-clicks-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['/Advertisers/{AccountSID}/Campaigns/{CampaignId}/Clicks/{ClickId}'].get
$.paths['/Mediapartners/{AccountSID}/Clicks/{Id}'].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 Impact Clicks API
  version: 1.0.0
extends: openapi/impact-clicks-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['/Advertisers/{AccountSID}/Campaigns/{CampaignId}/Clicks/{ClickId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get click details on a brand campaign
      effect: read
      questions:
      - How do I look up a click by its im_ref on my campaign?
      - Why can one click ID return several click objects?
      instructions:
      - text: Get click {click} on campaign {campaign} in brand account {sid}.
        slots:
          sid: path.AccountSID
          campaign: path.CampaignId
          click: path.ClickId
      - text: Show the consumer journey for click {click} in campaign {campaign}.
        slots:
          campaign: path.CampaignId
          click: path.ClickId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Mediapartners/{AccountSID}/Clicks/{Id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a click as a partner
      effect: read
      questions:
      - As a partner, can I see details of a click I drove?
      - What does a partner's click record contain?
      instructions:
      - text: Retrieve click {id} for partner account {sid}.
        slots:
          sid: path.AccountSID
          id: path.Id
      - text: Show my partner click {id}.
        slots:
          id: path.Id
      method: generated
      generated: '2026-09-26'