# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Impact Reports (Legacy) API
  version: 1.0.0
extends: openapi/impact-reports-legacy-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['/Agencies/{AccountSID}/Reports'].get
  update:
    x-apievangelist-phrasing:
      intent: List reports available to an agency
      effect: read
      questions:
      - Which reports can my agency run through the API?
      - Does the agency report catalog show which reports are API-runnable?
      instructions:
      - text: As agency account {account}, list all available reports.
        slots:
          account: path.AccountSID
      - text: Show agency {account} its report catalog with run and export URIs.
        slots:
          account: path.AccountSID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Agencies/{AccountSID}/Reports/{ReportId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Run an agency report synchronously (legacy)
      effect: read
      questions:
      - Can my agency run a report and get the rows back immediately?
      - Is there a result-size cap on running agency reports the legacy way?
      instructions:
      - text: As agency {account}, run report {report} from {start} to {end}.
        slots:
          account: path.AccountSID
          report: path.ReportId
          start: query.START_DATE
          end: query.END_DATE
      - text: Run agency report {report} for account {account} filtered to sub-affiliate {subaid}.
        slots:
          account: path.AccountSID
          report: path.ReportId
          subaid: query.SUBAID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Agencies/{AccountSID}/Reports/{ReportId}/MetaData'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an agency report's filters and columns
      effect: read
      questions:
      - Which filters and output columns does a given agency report have?
      - Before exporting, can an agency discover what parameters a report accepts?
      instructions:
      - text: As agency {account}, get the metadata for report {report}.
        slots:
          account: path.AccountSID
          report: path.ReportId
      - text: Show agency account {account} the filters and columns of report {report}.
        slots:
          account: path.AccountSID
          report: path.ReportId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Advertisers/{AccountSID}/Reports'].get
  update:
    x-apievangelist-phrasing:
      intent: List reports available to a brand
      effect: read
      questions:
      - Which reports can my brand account access?
      - Can a brand get its full list of reports?
      instructions:
      - text: As brand account {account}, list every report available.
        slots:
          account: path.AccountSID
      - text: Show brand {account}'s available reports.
        slots:
          account: path.AccountSID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Advertisers/{AccountSID}/Reports/{ReportId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Run a brand report synchronously (legacy)
      effect: read
      questions:
      - Can a brand run a report and get records back inline, without an export job?
      - Why is the brand's synchronous report endpoint considered legacy?
      instructions:
      - text: As brand {account}, run report {report} from {start} to {end}.
        slots:
          account: path.AccountSID
          report: path.ReportId
          start: query.StartDate
          end: query.EndDate
      - text: Run brand report {report} in account {account} for sub-affiliate {subaid}.
        slots:
          account: path.AccountSID
          report: path.ReportId
          subaid: query.SUBAID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Advertisers/{AccountSID}/Reports/{ReportId}/MetaData'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a brand report's filters and attributes
      effect: read
      questions:
      - What filters and attributes does one of my brand reports expose?
      - Can a brand read the generated documentation for a report?
      instructions:
      - text: As brand {account}, get the metadata for report {report}.
        slots:
          account: path.AccountSID
          report: path.ReportId
      - text: Show brand account {account} report {report}'s available filters and attributes.
        slots:
          account: path.AccountSID
          report: path.ReportId
      method: generated
      generated: '2026-09-26'