Awin · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Awin Commission Groups API

2 actions 2 updates phrasing extends openapi/awin-affiliate-commission-groups-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 2

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

OpenAPI Overlay

Raw ↑ 
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Awin Commission Groups API
  version: 1.0.0
extends: openapi/awin-affiliate-commission-groups-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: 1
- target: $.paths['/publishers/{publisherId}/commissiongroups'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an advertiser's commission groups and rates
      effect: read
      questions:
      - What commission rates does an advertiser pay me as a publisher on Awin?
      - Can I look up the commission rates a programme paid on a past date?
      - Which commission groups does an advertiser's programme have, and what conditions apply to them?
      instructions:
      - text: Show the commission groups advertiser {advertiserId} offers publisher {publisherId}.
        slots:
          advertiserId: query.advertiserId
          publisherId: path.publisherId
      - text: Get the commission rates advertiser {advertiserId} paid publisher {publisherId} as of {effectiveDate}.
        slots:
          advertiserId: query.advertiserId
          publisherId: path.publisherId
          effectiveDate: query.effectiveDate
      - text: List advertiser {advertiserId}'s commission groups for publisher {publisherId} including condition details ({extraConditionsDetails}).
        slots:
          advertiserId: query.advertiserId
          publisherId: path.publisherId
          extraConditionsDetails: query.extraConditionsDetails
      method: generated
      generated: '2026-10-01'