# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Awin Reports API
  version: 1.0.0
extends: openapi/awin-affiliate-reports-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: 6
- target: $.paths['/publishers/{publisherId}/reports/advertiser'].get
  update:
    x-apievangelist-phrasing:
      intent: Report a publisher's performance by advertiser
      effect: read
      questions:
      - Which advertisers earned me the most as a publisher over a date range?
      - Can I break my publisher performance down per advertiser for one region?
      - How do I get aggregated publisher totals per advertiser on Awin?
      instructions:
      - text: Report publisher {publisherId}'s performance by advertiser from {startDate} to {endDate} in region {region}.
        slots:
          publisherId: path.publisherId
          startDate: query.startDate
          endDate: query.endDate
          region: query.region
      - text: Break down publisher {publisherId}'s results per advertiser for {region} between {startDate} and {endDate} in timezone {timezone}.
        slots:
          publisherId: path.publisherId
          region: query.region
          startDate: query.startDate
          endDate: query.endDate
          timezone: query.timezone
      method: generated
      generated: '2026-10-01'
- target: $.paths['/publishers/{publisherId}/reports/creative'].get
  update:
    x-apievangelist-phrasing:
      intent: Report a publisher's performance by creative
      effect: read
      questions:
      - Which banners and creatives drove the most clicks and impressions on my publisher site?
      - What impressions did each creative I ran get in a given region?
      instructions:
      - text: Report publisher {publisherId}'s clicks, impressions and transactions by creative from {startDate} to {endDate} in region {region}.
        slots:
          publisherId: path.publisherId
          startDate: query.startDate
          endDate: query.endDate
          region: query.region
      - text: Rank the creatives publisher {publisherId} ran in {region} between {startDate} and {endDate}.
        slots:
          publisherId: path.publisherId
          region: query.region
          startDate: query.startDate
          endDate: query.endDate
      method: generated
      generated: '2026-10-01'
- target: $.paths['/publishers/{publisherId}/reports/campaign'].get
  update:
    x-apievangelist-phrasing:
      intent: Report a publisher's performance by campaign
      effect: read
      questions:
      - Which campaigns brought me the most clicks and sales as a publisher?
      - Can I see my publisher campaign results by day, month or year?
      instructions:
      - text: Report publisher {publisherId}'s clicks and transactions by campaign from {startDate} to {endDate}.
        slots:
          publisherId: path.publisherId
          startDate: query.startDate
          endDate: query.endDate
      - text: Show publisher {publisherId}'s campaign performance per advertiser between {startDate} and {endDate} in {timezone}.
        slots:
          publisherId: path.publisherId
          startDate: query.startDate
          endDate: query.endDate
          timezone: query.timezone
      method: generated
      generated: '2026-10-01'
- target: $.paths['/advertisers/{advertiserId}/reports/publisher'].get
  update:
    x-apievangelist-phrasing:
      intent: Report an advertiser's performance by publisher
      effect: read
      questions:
      - Which publishers drive the most sales for my advertiser programme?
      - What did each affiliate partner deliver for my brand last month?
      instructions:
      - text: As advertiser {advertiserId}, give me totals for each affiliate partner over {startDate} to {endDate}, timezone {timezone}.
        slots:
          advertiserId: path.advertiserId
          startDate: query.startDate
          endDate: query.endDate
          timezone: query.timezone
      - text: Rank the publishers working for advertiser {advertiserId} between {startDate} and {endDate} ({timezone}).
        slots:
          advertiserId: path.advertiserId
          startDate: query.startDate
          endDate: query.endDate
          timezone: query.timezone
      method: generated
      generated: '2026-10-01'
- target: $.paths['/advertisers/{advertiserId}/reports/creative'].get
  update:
    x-apievangelist-phrasing:
      intent: Report an advertiser's performance by creative
      effect: read
      questions:
      - Which of my advertiser creatives get the most impressions across publishers?
      - How do I compare clicks and transactions for each banner I supply to affiliates?
      instructions:
      - text: For my brand account {advertiserId}, compare how each banner I gave affiliates performed in {region} from {startDate} to {endDate}.
        slots:
          advertiserId: path.advertiserId
          startDate: query.startDate
          endDate: query.endDate
          region: query.region
      - text: Rank the creatives advertiser {advertiserId} supplied in {region} between {startDate} and {endDate}.
        slots:
          advertiserId: path.advertiserId
          region: query.region
          startDate: query.startDate
          endDate: query.endDate
      method: generated
      generated: '2026-10-01'
- target: $.paths['/advertisers/{advertiserId}/reports/campaign'].get
  update:
    x-apievangelist-phrasing:
      intent: Report an advertiser's performance by campaign
      effect: read
      questions:
      - Which of my advertiser campaigns drew the most clicks and sales from publishers?
      - Can I see my advertiser campaign results broken out per publisher by month?
      instructions:
      - text: Report advertiser {advertiserId}'s clicks and transactions by campaign from {startDate} to {endDate}.
        slots:
          advertiserId: path.advertiserId
          startDate: query.startDate
          endDate: query.endDate
      - text: Break my brand account {advertiserId}'s campaigns out by affiliate partner from {startDate} to {endDate}, timezone {timezone}.
        slots:
          advertiserId: path.advertiserId
          startDate: query.startDate
          endDate: query.endDate
          timezone: query.timezone
      method: generated
      generated: '2026-10-01'