Awin · OpenAPI Overlay 1.0.0

API Evangelist enhancements for Awin Accounts Reports API

7 actions 7 updates update extends openapi/awin-affiliate-reports-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-docsx-agentic-accessx-entitlementx-apievangelist-providerx-apievangelist-enrichedx-apievangelist-spec-originx-apievangelist-llms-txtx-rate-limit

Targets 7

$.info

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

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

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

$.paths['/advertisers/{advertiserId}/reports/publisher'].get

$.paths['/advertisers/{advertiserId}/reports/creative'].get

$.paths['/advertisers/{advertiserId}/reports/campaign'].get

OpenAPI Overlay

overlay: 1.0.0
info:
  title: API Evangelist enhancements for Awin Accounts Reports API
  version: 1.0.0
extends: openapi/awin-affiliate-reports-api-openapi.yml
x-generated: '2026-08-13'
x-method: generated
x-source: https://help.awin.com/apidocs + this repo artifacts
actions:
- target: $.info
  description: Record API Evangelist provenance and the platform constraints Awin documents in prose but
    never encodes in a contract.
  update:
    x-apievangelist-provider: awin-affiliate
    x-apievangelist-enriched: '2026-08-13'
    x-apievangelist-spec-origin: reconstructed-from-docs
    x-apievangelist-docs: https://help.awin.com/apidocs/introduction-1
    x-apievangelist-llms-txt: https://help.awin.com/llms.txt
    x-rate-limit:
      requests: 20
      window: 1m
      scope: user
      headers: null
      exhaustion-status: 429
      docs: https://help.awin.com/apidocs/introduction-1
    x-idempotency:
      supported: false
      note: Awin documents no idempotency key on any surface.
    x-pagination:
      supported: false
      note: No page/offset/cursor/limit parameters; result sets are bounded by date windows.
    x-sandbox:
      available: false
      note: No test mode, no test credentials. Every call is production.
    x-status-page: https://status.awin.com
- target: $.paths['/publishers/{publisherId}/reports/advertiser'].get
  description: Attach documentation link, agentic-access classification.
  update:
    x-apievangelist-docs: https://help.awin.com/apidocs/get-advertiser-performance-report
    x-agentic-access:
      action-class: connected
      consequence: read
      token:
        max-ttl: 3600
- target: $.paths['/publishers/{publisherId}/reports/creative'].get
  description: Attach documentation link, agentic-access classification.
  update:
    x-apievangelist-docs: https://help.awin.com/apidocs/get-publisher-creative-performance-report
    x-agentic-access:
      action-class: connected
      consequence: read
      token:
        max-ttl: 3600
- target: $.paths['/publishers/{publisherId}/reports/campaign'].get
  description: Attach documentation link, agentic-access classification.
  update:
    x-apievangelist-docs: https://help.awin.com/apidocs/get-campaign-data-for-publisher-report
    x-agentic-access:
      action-class: connected
      consequence: read
      token:
        max-ttl: 3600
- target: $.paths['/advertisers/{advertiserId}/reports/publisher'].get
  description: Attach documentation link, agentic-access classification and the documented request constraints.
  update:
    x-apievangelist-docs: https://help.awin.com/apidocs/get-publisher-performance-report
    x-agentic-access:
      action-class: connected
      consequence: read
      token:
        max-ttl: 3600
    x-entitlement:
      plans:
      - Accelerate
      - Advanced
      note: Awin states advertiser API access is limited to the Accelerate and Advanced plans; a 403 here
        is commercial, not technical.
- target: $.paths['/advertisers/{advertiserId}/reports/creative'].get
  description: Attach documentation link, agentic-access classification and the documented request constraints.
  update:
    x-apievangelist-docs: https://help.awin.com/apidocs/get-advertiser-creative-performance-report
    x-agentic-access:
      action-class: connected
      consequence: read
      token:
        max-ttl: 3600
    x-entitlement:
      plans:
      - Accelerate
      - Advanced
      note: Awin states advertiser API access is limited to the Accelerate and Advanced plans; a 403 here
        is commercial, not technical.
- target: $.paths['/advertisers/{advertiserId}/reports/campaign'].get
  description: Attach documentation link, agentic-access classification and the documented request constraints.
  update:
    x-apievangelist-docs: https://help.awin.com/apidocs/get-campaign-data-for-advertiser-report
    x-agentic-access:
      action-class: connected
      consequence: read
      token:
        max-ttl: 3600
    x-entitlement:
      plans:
      - Accelerate
      - Advanced
      note: Awin states advertiser API access is limited to the Accelerate and Advanced plans; a 403 here
        is commercial, not technical.