# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Outbrain Reporting API
  version: 1.0.0
extends: openapi/outbrain-reporting-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: 7
- target: $.paths['/reports/marketers/{marketerId}/campaigns'].get
  update:
    x-apievangelist-phrasing:
      intent: Report performance by campaign for a date range
      effect: read
      questions:
      - How much did each campaign spend and convert last month?
      - What's the rate limit on the campaign performance report?
      - Can I get CPA and CTR per campaign with a breakdown?
      instructions:
      - text: Report campaign performance for marketer {marketerId} from {from} to {to}.
        slots:
          marketerId: path.marketerId
          from: query.from
          to: query.to
      - text: Break down marketer {marketerId} campaign spend by {breakdown} between {from} and {to}.
        slots:
          marketerId: path.marketerId
          breakdown: query.breakdown
          from: query.from
          to: query.to
      method: generated
      generated: '2026-09-26'
- target: $.paths['/reports/marketers/{marketerId}/periodicContent'].get
  update:
    x-apievangelist-phrasing:
      intent: Report promoted link performance over a period
      effect: read
      questions:
      - Which ads performed best over the past two weeks?
      - How can I see results for each promoted link over a date range?
      instructions:
      - text: Report promoted link results for marketer {marketerId} from {from} to {to}.
        slots:
          marketerId: path.marketerId
          from: query.from
          to: query.to
      - text: Show each ad creative's performance under marketer {marketerId} since {from} through {to}.
        slots:
          marketerId: path.marketerId
          from: query.from
          to: query.to
      method: generated
      generated: '2026-09-26'
- target: $.paths['/reports/marketers/{marketerId}/realtime'].get
  update:
    x-apievangelist-phrasing:
      intent: Get real-time performance for a marketer
      effect: read
      questions:
      - How are my campaigns doing right now?
      - How many real-time report calls can I make per minute?
      instructions:
      - text: Show real-time performance for marketer {marketerId}.
        slots:
          marketerId: path.marketerId
      - text: Pull live metrics for marketer {marketerId} right now.
        slots:
          marketerId: path.marketerId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/custom'].post
  update:
    x-apievangelist-phrasing:
      intent: Start an asynchronous custom report
      effect: write
      questions:
      - How do I request a large custom report that runs in the background?
      - What ID do I get back when I trigger report processing?
      instructions:
      - text: Start processing a custom report for last quarter.
      - text: Kick off an asynchronous report job and give me its ID.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/custom/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a custom report's processing status
      effect: read
      questions:
      - Is my custom report still queued or has it finished?
      - How do I know when a background report is ready?
      instructions:
      - text: Check the status of report {id}.
        slots:
          id: path.id
      - text: Tell me whether custom report {id} has finished processing.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/running/list'].get
  update:
    x-apievangelist-phrasing:
      intent: List reports currently processing
      effect: read
      questions:
      - Which custom reports are running right now?
      - Can I see all reports still in the processing queue?
      instructions:
      - text: List the reports that are currently processing.
      - text: Show every running report job and its status.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/custom/{id}/kill'].put
  update:
    x-apievangelist-phrasing:
      intent: Cancel a report that is processing
      effect: destructive
      questions:
      - How do I stop a custom report I no longer need?
      - Can I kill a report while it's still being processed?
      instructions:
      - text: Cancel report {id}.
        slots:
          id: path.id
      - text: Kill the processing job for custom report {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'