Awin
API Documentation: Awin API Documentation
Awin is a global affiliate marketing network connecting advertisers with publishers. The Awin API allows you to access data for both advertiser and publisher accounts, including:
- Transactions: Sales, commissions, and conversion data tracked through affiliate links.
- Performance Reports: Campaign, creative, and publisher/advertiser performance metrics at various time granularities.
- Programme Data: Information about affiliate programmes, commission groups, and promotions.
- Validation: Transaction validation jobs and status tracking.
Authentication
To authenticate the Awin source, you’ll need an API access token from your Awin account.
Prerequisites
- An Awin account (advertiser or publisher)
- An API token with access to the accounts you want to sync
Find your API Token
In Awin, you can find your API token in the API Credentials section of your account settings:
- Log in to your Awin account at ui.awin.com
- Navigate to Settings → API Credentials
- Generate or copy your existing API token
Setup
- In the app, open Sources and select Awin.
- Enter your API token (access token).
- (Optional) Configure which advertiser/publisher accounts to sync and any optional feed settings.
- Save and test the connection.
Configuration
| Field | Type | Required | Description |
|---|---|---|---|
access_token | string | ✅ | Your Awin API token. Used as a Bearer token for API requests. |
backfill | integer | Number of days of historical data to pull on each run (used to capture late-arriving updates). Defaults to 7. | |
advertiser_accounts_to_sync | string[] | Optional allowlist of advertiser account IDs to sync. If omitted, all accessible advertiser accounts are synced. | |
publisher_accounts_to_sync | string[] | Optional allowlist of publisher account IDs to sync. If omitted, all accessible publisher accounts are synced. | |
programme_relationship | string | Filters publisher programme streams by relationship status. One of: joined, pending, suspended, rejected, notjoined, any. Defaults to joined. | |
feed_targets | object[] | Optional list of product feed targets to download. Each entry must include publisher_id, advertiser_id, and locale (format like en_GB). |
feed_targets object shape
Each feed_targets entry has:
| Field | Type | Required | Description |
|---|---|---|---|
publisher_id | string | ✅ | Publisher account ID that has access to the feed. |
advertiser_id | string | ✅ | Advertiser account ID for the feed. |
locale | string | ✅ | Feed locale in the form ll_CC (e.g., en_GB), where ll is lowercase language and CC is uppercase country. |
Connection Setup Guide
Once you connect Awin to a destination, you will also need to configure:
- Connection Pull Schedule: Determines how frequently data is extracted from the source.
- Backfill (Days): Specifies the duration for which historical data will be retrieved during each connection run.
- Destination specific settings: Different settings such as "Dataset Name" or "Target Schema" (depending on your destination).
- Schema Migration Policy: Controls how Extract will handle schema changes from the source.
Schema ERD
Explore the interactive entity relationship diagram for Awin.
Data Streams
Common Streams
accounts
Returns information about accounts (advertiser and publisher) associated with your API token.
Advertiser Streams
Streams available for advertiser accounts.
Transactions
advertiser_transactions
Transaction-level data for advertisers including sales, commissions, click data, and conversion details.
advertiser_validation_jobs
Validation jobs created by the advertiser for processing transactions.
advertiser_validation_job_details
Detailed information about specific validation jobs.
Campaign Performance
advertiser_campaign_performance_daily
Daily campaign performance metrics for advertisers.
advertiser_campaign_performance_monthly
Monthly aggregated campaign performance metrics for advertisers.
advertiser_campaign_performance_yearly
Yearly aggregated campaign performance metrics for advertisers.
advertiser_campaign_performance_range
Campaign performance metrics for a custom date range for advertisers.
Creative Performance
advertiser_creative_performance_transaction
Creative performance metrics based on transaction data for advertisers.
advertiser_creative_performance_validation
Creative performance metrics based on validation data for advertisers.
Publisher Performance
advertiser_publishers
List of publishers associated with the advertiser's programme.
advertiser_publisher_performance_transaction
Publisher performance metrics based on transaction data for advertisers.
advertiser_publisher_performance_validation
Publisher performance metrics based on validation data for advertisers.
Publisher Streams
Streams available for publisher accounts.
Transactions
publisher_transactions
Transaction-level data for publishers including sales, commissions, click data, and conversion details.
publisher_transaction_queries
Transaction query data for publishers.
Campaign Performance
publisher_campaign_performance_daily
Daily campaign performance metrics for publishers.
publisher_campaign_performance_monthly
Monthly aggregated campaign performance metrics for publishers.
publisher_campaign_performance_yearly
Yearly aggregated campaign performance metrics for publishers.
publisher_campaign_performance_range
Campaign performance metrics for a custom date range for publishers.
Creative Performance
publisher_creative_performance_transaction
Creative performance metrics based on transaction data for publishers.
publisher_creative_performance_validation
Creative performance metrics based on validation data for publishers.
Advertiser Performance
publisher_advertiser_performance_transaction
Advertiser performance metrics based on transaction data for publishers.
publisher_advertiser_performance_validation
Advertiser performance metrics based on validation data for publishers.
Programmes
publisher_programmes
List of affiliate programmes the publisher is associated with.
publisher_programme_details
Detailed information about specific programmes including terms and conditions.
Commissions
publisher_commission_groups
Commission group configurations for publisher accounts.
publisher_commission_sharing_rules
Commission sharing rules defining how commissions are split.
Promotions & Products
publisher_promotions
Promotional offers and campaigns available to publishers.
publisher_enhanced_feed_products
Product feed data with enhanced attributes for affiliate marketing.
Notes
- Data availability depends on your account type (advertiser or publisher) and API permissions.
- The connector can sync all accessible accounts by default, or you can restrict sync to specific advertiser/publisher account IDs using the allowlist configuration fields.
- Transaction data supports incremental sync (the connector uses a rolling backfill window to capture updates).
- Performance reports are available at daily, monthly, yearly, and custom date range granularities.
- The
account_typefield in records indicates whether the data is from an advertiser or publisher account.