Impact · OpenAPI Overlay 1.0.0

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

4 actions 4 updates phrasing extends openapi/impact-ftp-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 4

$.info

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

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

$.paths['/Advertisers/{AccountSID}/FTPFileSubmissions/{BatchId}/ErrorDetails'].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 Brand API - Submissions FTP Submissions API
  version: 1.0.0
extends: openapi/impact-ftp-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: 3
- target: $.paths['/Advertisers/{AccountSID}/FTPFileSubmissions'].get
  update:
    x-apievangelist-phrasing:
      intent: List FTP file submissions
      effect: read
      questions:
      - Which conversion files have I uploaded over FTP recently?
      - Can I filter FTP file submissions by when they completed processing?
      instructions:
      - text: List FTP file submissions in account {account} submitted between {start} and {end}.
        slots:
          account: path.AccountSID
          start: query.SubmissionDateStart
          end: query.SubmissionDateEnd
      - text: Show FTP batches for account {account} completed after {done}.
        slots:
          account: path.AccountSID
          done: query.CompletedDateStart
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Advertisers/{AccountSID}/FTPFileSubmissions/{BatchId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an FTP batch submission's details
      effect: read
      questions:
      - How many records in one FTP batch file were accepted?
      - Can I check the processing status of a specific FTP upload?
      instructions:
      - text: Get FTP batch {batch} details in account {account}.
        slots:
          account: path.AccountSID
          batch: path.BatchId
      - text: Show what records were submitted in FTP file {batch}, account {account}.
        slots:
          account: path.AccountSID
          batch: path.BatchId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Advertisers/{AccountSID}/FTPFileSubmissions/{BatchId}/ErrorDetails'].get
  update:
    x-apievangelist-phrasing:
      intent: List errors in an FTP batch file
      effect: read
      questions:
      - Why did rows in my FTP upload fail?
      - Can I get every error found within one FTP file submission?
      instructions:
      - text: List the errors in FTP batch {batch} for account {account}.
        slots:
          account: path.AccountSID
          batch: path.BatchId
      - text: Show which rows failed in FTP submission {batch}, account {account}.
        slots:
          account: path.AccountSID
          batch: path.BatchId
      method: generated
      generated: '2026-09-26'