Impact · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Impact Click Export API

3 actions 3 updates phrasing extends openapi/impact-clickexport-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}/Programs/{ProgramId}/ClickExport'].get

$.paths['/Mediapartners/{AccountSID}/ClickExport'].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 Impact Click Export API
  version: 1.0.0
extends: openapi/impact-clickexport-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}/Programs/{ProgramId}/ClickExport'].get
  update:
    x-apievangelist-phrasing:
      intent: Export a brand program's daily clicks
      effect: read
      questions:
      - Can my brand export all clicks on a program for a given day?
      - Is a brand click export only unique clicks, or can I include all?
      instructions:
      - text: As brand account {account}, export clicks for program {program} on {date}.
        slots:
          account: path.AccountSID
          program: path.ProgramId
          date: query.Date
      - text: Export brand program {program} clicks for ad {ad} as {format}, account {account}.
        slots:
          account: path.AccountSID
          program: path.ProgramId
          ad: query.AdId
          format: query.ResultFormat
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Mediapartners/{AccountSID}/ClickExport'].get
  update:
    x-apievangelist-phrasing:
      intent: Export a partner's clicks
      effect: read
      questions:
      - As a partner, how can I export the clicks I sent?
      - Where do I download a partner click export once the job finishes?
      instructions:
      - text: As partner account {account}, export my clicks on {date}.
        slots:
          account: path.AccountSID
          date: query.Date
      - text: Export partner clicks for program {program} with sub ID {subid} in account {account}.
        slots:
          account: path.AccountSID
          program: query.ProgramId
          subid: query.SubId
      method: generated
      generated: '2026-09-26'