Impact · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Impact Report Export API

4 actions 4 updates phrasing extends openapi/impact-report-export-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}/ReportExport/{ReportId_or_Handle}'].get

$.paths['/Mediapartners/{AccountSID}/ReportExport/{Id}'].get

$.paths['/Agencies/{AccountSID}/ReportExport/{ReportId}'].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 Impact Report Export API
  version: 1.0.0
extends: openapi/impact-report-export-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 3
- target: $.paths['/Advertisers/{AccountSID}/ReportExport/{ReportId_or_Handle}'].get
  update:
    x-apievangelist-phrasing:
      intent: Export a brand report as a job
      effect: write
      questions:
      - How do I export a large brand report without waiting on the request?
      - Can I choose CSV or another format for a brand report export?
      instructions:
      - text: Export brand report {report} from account {sid}.
        slots:
          sid: path.AccountSID
          report: path.ReportId_or_Handle
      - text: Schedule advertiser report {report} for {start} to {end} as {fmt}.
        slots:
          report: path.ReportId_or_Handle
          start: query.StartDate
          end: query.EndDate
          fmt: query.ResultFormat
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Mediapartners/{AccountSID}/ReportExport/{Id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Export a partner report as a job
      effect: write
      questions:
      - How does a partner export a report in the background?
      - What date range do I have to give when exporting a partner report?
      instructions:
      - text: Export partner report {id} on account {sid} from {start} to {end}.
        slots:
          sid: path.AccountSID
          id: path.Id
          start: query.START_DATE
          end: query.END_DATE
      - text: Queue media partner report {id} for {start}–{end} in {fmt} format.
        slots:
          id: path.Id
          start: query.START_DATE
          end: query.END_DATE
          fmt: query.ResultFormat
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Agencies/{AccountSID}/ReportExport/{ReportId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Export an agency report as a job
      effect: write
      questions:
      - How does my agency export a report asynchronously?
      - What URIs come back when an agency schedules a report export?
      instructions:
      - text: Export agency report {report} from account {sid}.
        slots:
          sid: path.AccountSID
          report: path.ReportId
      - text: Schedule agency report {report} from {start} to {end} in {fmt}.
        slots:
          report: path.ReportId
          start: query.START_DATE
          end: query.END_DATE
          fmt: query.ResultFormat
      method: generated
      generated: '2026-10-01'