Impact · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Impact Action Inquiries API

7 actions 7 updates phrasing extends openapi/impact-action-inquiries-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 7

$.info
$.paths['/Advertisers/{AccountSID}/ActionInquiries'].get
$.paths['/Advertisers/{AccountSID}/ActionInquiries'].put
$.paths['/Advertisers/{AccountSID}/ActionInquiries/{InquiryId}'].get
$.paths['/Mediapartners/{AccountSID}/ActionInquiries'].get
$.paths['/Mediapartners/{AccountSID}/ActionInquiries'].post
$.paths['/Mediapartners/{AccountSID}/ActionInquiries/{InquiryId}'].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 Action Inquiries API
  version: 1.0.0
extends: openapi/impact-action-inquiries-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: 6
- target: $.paths['/Advertisers/{AccountSID}/ActionInquiries'].get
  update:
    x-apievangelist-phrasing:
      intent: List inquiries partners raised on a campaign
      effect: read
      questions:
      - Which missing-commission inquiries have partners filed against my campaign?
      - Can I filter brand-side inquiries by resolution status or order ID?
      instructions:
      - text: List action inquiries for campaign {campaign} in brand account {sid}.
        slots:
          sid: path.AccountSID
          campaign: query.CampaignId
      - text: Show campaign {campaign} inquiries with resolution status {status}.
        slots:
          campaign: query.CampaignId
          status: query.ResolutionStatus
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Advertisers/{AccountSID}/ActionInquiries'].put
  update:
    x-apievangelist-phrasing:
      intent: Resolve an action inquiry
      effect: write
      questions:
      - How do I approve or reject a partner's action inquiry?
      - Can I record a final payout when resolving an inquiry?
      instructions:
      - text: Set inquiry {id} in account {sid} to resolution status {status}.
        slots:
          sid: path.AccountSID
          id: requestBody.Id
          status: requestBody.ResolutionStatus
      - text: Reject inquiry {id} with status {status} and reason {reason}.
        slots:
          id: requestBody.Id
          status: requestBody.ResolutionStatus
          reason: requestBody.RejectReason
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Advertisers/{AccountSID}/ActionInquiries/{InquiryId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an inquiry's details as a brand
      effect: read
      questions:
      - What did a partner claim in a specific action inquiry on my program?
      - Can a brand look up one inquiry by its ID?
      instructions:
      - text: Get brand-side details of inquiry {inq} in account {sid}.
        slots:
          sid: path.AccountSID
          inq: path.InquiryId
      - text: Show the advertiser view of action inquiry {inq}.
        slots:
          inq: path.InquiryId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Mediapartners/{AccountSID}/ActionInquiries'].get
  update:
    x-apievangelist-phrasing:
      intent: List a partner's action inquiries
      effect: read
      questions:
      - Which action inquiries have I submitted as a partner?
      - Can I check my inquiries by transaction date range?
      instructions:
      - text: List the inquiries I've filed from partner account {sid}.
        slots:
          sid: path.AccountSID
      - text: Show my partner inquiries for customer {cust}.
        slots:
          cust: query.CustomerId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Mediapartners/{AccountSID}/ActionInquiries'].post
  update:
    x-apievangelist-phrasing:
      intent: File an action inquiry for a missing sale
      effect: write
      questions:
      - How do I claim a sale that wasn't tracked?
      - What details do I need to submit an inquiry about a missing commission?
      instructions:
      - text: File a {type} inquiry in account {sid} for order {order} on campaign {campaign}, {amount} on {date}.
        slots:
          sid: path.AccountSID
          type: requestBody.InquiryType
          order: requestBody.OrderId
          campaign: requestBody.CampaignId
          amount: requestBody.TransactionAmount
          date: requestBody.TransactionDate
      - text: Claim untracked order {order} worth {amount} from {date} in campaign {campaign} as a {type} inquiry.
        slots:
          order: requestBody.OrderId
          amount: requestBody.TransactionAmount
          date: requestBody.TransactionDate
          campaign: requestBody.CampaignId
          type: requestBody.InquiryType
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Mediapartners/{AccountSID}/ActionInquiries/{InquiryId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check one of my action inquiries
      effect: read
      questions:
      - What's the status of an inquiry I filed as a partner?
      - Has the brand resolved my missing-sale claim yet?
      instructions:
      - text: Retrieve my partner inquiry {inq} on account {sid}.
        slots:
          sid: path.AccountSID
          inq: path.InquiryId
      - text: Check resolution of the inquiry {inq} I submitted.
        slots:
          inq: path.InquiryId
      method: generated
      generated: '2026-09-26'