Awin · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Awin Transactions API

3 actions 3 updates phrasing extends openapi/awin-affiliate-transactions-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Awin's API. It is a proposal applied on top of the contract, not a document Awin publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/publishers/{publisherId}/transactions/'].get

$.paths['/advertisers/{advertiserId}/transactions/'].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 Awin Transactions API
  version: 1.0.0
extends: openapi/awin-affiliate-transactions-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: 2
- target: $.paths['/publishers/{publisherId}/transactions/'].get
  update:
    x-apievangelist-phrasing:
      intent: List a publisher's individual transactions
      effect: read
      questions:
      - Which individual sales did I earn commission on as a publisher last week?
      - Can I pull more than 31 days of publisher transactions in one request?
      - Is it possible to see the basket products behind each sale I referred?
      instructions:
      - text: Pull transactions for publisher {publisherId} from {startDate} to {endDate} in {timezone}.
        slots:
          publisherId: path.publisherId
          startDate: query.startDate
          endDate: query.endDate
          timezone: query.timezone
      - text: List publisher {publisherId}'s {status} transactions with advertiser {advertiserId} between {startDate} and {endDate} ({timezone}).
        slots:
          publisherId: path.publisherId
          status: query.status
          advertiserId: query.advertiserId
          startDate: query.startDate
          endDate: query.endDate
          timezone: query.timezone
      method: generated
      generated: '2026-10-01'
- target: $.paths['/advertisers/{advertiserId}/transactions/'].get
  update:
    x-apievangelist-phrasing:
      intent: List an advertiser's individual transactions
      effect: read
      questions:
      - How do I export every affiliate sale tracked for my advertiser account in a date range?
      - Can I filter my advertiser transactions down to one or a few publishers?
      - Which tracked conversions on my advertiser programme are still pending?
      instructions:
      - text: Pull transactions for advertiser {advertiserId} from {startDate} to {endDate} in {timezone}.
        slots:
          advertiserId: path.advertiserId
          startDate: query.startDate
          endDate: query.endDate
          timezone: query.timezone
      - text: List advertiser {advertiserId}'s {status} transactions driven by publisher {publisherId} between {startDate} and {endDate} ({timezone}).
        slots:
          advertiserId: path.advertiserId
          status: query.status
          publisherId: query.publisherId
          startDate: query.startDate
          endDate: query.endDate
          timezone: query.timezone
      method: generated
      generated: '2026-10-01'