Impact · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Brand Tracking Value Requests API

5 actions 5 updates phrasing extends openapi/impact-tracking-value-requests-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 5

$.info

$.paths['/Advertisers/{AccountSID}/TrackingValueRequests'].get

$.paths['/Advertisers/{AccountSID}/TrackingValueRequests/{RequestId}'].get

$.paths['/Advertisers/{AccountSID}/TrackingValueRequests/{RequestId}'].put

$.paths['/Advertisers/{AccountSID}/TrackingValueRequests/{RequestId}'].delete

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 Brand Tracking Value Requests API
  version: 1.0.0
extends: openapi/impact-tracking-value-requests-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: 4
- target: $.paths['/Advertisers/{AccountSID}/TrackingValueRequests'].get
  update:
    x-apievangelist-phrasing:
      intent: List partner tracking value requests
      effect: read
      questions:
      - Which promo code or vanity URL requests are partners waiting on me to approve?
      - Can I filter tracking value requests by partner, deal or state?
      instructions:
      - text: List tracking value requests in account {account} with state {state}.
        slots:
          account: path.AccountSID
          state: query.State
      - text: Show tracking value requests from partner {partner} in account {account}.
        slots:
          account: path.AccountSID
          partner: query.MediaPartnerId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Advertisers/{AccountSID}/TrackingValueRequests/{RequestId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a tracking value request
      effect: read
      questions:
      - What exactly did a partner ask for in one tracking value request?
      - Can I look up a single tracking value request by ID?
      instructions:
      - text: Get tracking value request {request} in account {account}.
        slots:
          account: path.AccountSID
          request: path.RequestId
      - text: Show the details of tracking request {request}, account {account}.
        slots:
          account: path.AccountSID
          request: path.RequestId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Advertisers/{AccountSID}/TrackingValueRequests/{RequestId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Approve a tracking value request
      effect: write
      questions:
      - How do I approve a partner's request for a dedicated promo code?
      - What parameters does approving a tracking value request need per request type?
      instructions:
      - text: Approve tracking value request {request} in account {account} with promo code {code}.
        slots:
          account: path.AccountSID
          request: path.RequestId
          code: requestBody.PromoCode
      - text: Approve request {request} in account {account} and tie it to deal {deal}.
        slots:
          account: path.AccountSID
          request: path.RequestId
          deal: requestBody.DealId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Advertisers/{AccountSID}/TrackingValueRequests/{RequestId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Reject a tracking value request
      effect: destructive
      questions:
      - Can I decline a partner's tracking value request?
      - What happens when I turn down a promo code request?
      instructions:
      - text: Reject tracking value request {request} in account {account}.
        slots:
          account: path.AccountSID
          request: path.RequestId
      - text: Decline partner request {request} for account {account}.
        slots:
          account: path.AccountSID
          request: path.RequestId
      method: generated
      generated: '2026-09-26'