Impact · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Impact Tracking Links API

3 actions 3 updates phrasing extends openapi/impact-tracking-links-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}/TrackingLinks'].post

$.paths['/Mediapartners/{AccountSID}/Programs/{ProgramId}/TrackingLinks'].post

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 Tracking Links API
  version: 1.0.0
extends: openapi/impact-tracking-links-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}/TrackingLinks'].post
  update:
    x-apievangelist-phrasing:
      intent: Generate a tracking link for a partner (brand)
      effect: write
      questions:
      - As a brand, can I generate a tracking link on behalf of one of my partners?
      - Can a brand-generated tracking link deep link to a specific page?
      instructions:
      - text: As brand account {account}, generate a tracking link in program {program} for partner {partner}.
        slots:
          account: path.AccountSID
          program: path.ProgramId
          partner: query.MediaPartnerId
      - text: Create a brand-issued link for partner {partner} in program {program} that deep links to {deeplink}, account {account}.
        slots:
          account: path.AccountSID
          program: path.ProgramId
          partner: query.MediaPartnerId
          deeplink: requestBody.DeepLink
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Mediapartners/{AccountSID}/Programs/{ProgramId}/TrackingLinks'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a tracking link as a partner
      effect: write
      questions:
      - How do I create my own tracking link for a program I promote?
      - Is there a limit on how many vanity links a partner can have?
      instructions:
      - text: As partner account {account}, create a tracking link for program {program}.
        slots:
          account: path.AccountSID
          program: path.ProgramId
      - text: Make a vanity link at {path} for program {program} with sub ID {subid}, account {account}.
        slots:
          account: path.AccountSID
          program: path.ProgramId
          path: query.CustomPath
          subid: query.subId1
      method: generated
      generated: '2026-09-26'