Impact · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Brand API - Submissions API Submissions API

3 actions 3 updates phrasing extends openapi/impact-api-submissions-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}/APISubmissions'].get
$.paths['/Advertisers/{AccountSID}/APISubmissions/{BatchId}'].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 Brand API - Submissions API Submissions API
  version: 1.0.0
extends: openapi/impact-api-submissions-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}/APISubmissions'].get
  update:
    x-apievangelist-phrasing:
      intent: List API conversion submissions
      effect: read
      questions:
      - Which records have I submitted through the API?
      - Why is listing all API submissions discouraged?
      instructions:
      - text: List all API submissions for account {account}.
        slots:
          account: path.AccountSID
      - text: Show the API submission batches in account {account}.
        slots:
          account: path.AccountSID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Advertisers/{AccountSID}/APISubmissions/{BatchId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an API submission's status and errors
      effect: read
      questions:
      - Did a conversion I sent through the API process successfully?
      - Can I see the errors on one API submission?
      instructions:
      - text: Get API submission {batch} in account {account}.
        slots:
          account: path.AccountSID
          batch: path.BatchId
      - text: Check processing status and errors for submission {batch}, account {account}.
        slots:
          account: path.AccountSID
          batch: path.BatchId
      method: generated
      generated: '2026-09-26'