> ## Documentation Index
> Fetch the complete documentation index at: https://docs.adriel.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Data reference

> Metrics, breakdowns, refresh cadence, and limits for the Awin data source in Adriel.

## Introduction

Awin is an affiliate marketing network. The Awin connector pulls publisher performance and transaction-level data from the Awin REST API for the connected advertiser account. Two report shapes are supported: a publisher report that aggregates impressions, clicks, and commission-status totals per publisher per day, and a transaction report that exposes one row per individual transaction.

As a marketing connector, metrics, breakdowns, and currencies are standardized so widgets can aggregate across sources without additional configuration.

To connect this data source, see [How to connect Awin to Adriel](/data-sources/a-f/awin/how-to-connect).

## Data refresh strategy

### Architecture data

Account structure — the advertiser account and its associated publishers — is resolved at connection time by calling the Awin accounts endpoint with `type=advertiser`, and is refreshed alongside reports data.

### Reports data

Awin is a daily-cache connector. After initial connection, historic daily data from the last **180 days** is retrieved. The latest **30 days** are then refreshed **every 3 hours at minute 0 (UTC)**. Each fetch covers a single calendar day, so a first-time backfill issues one request per day of history.

## Architecture levels

Advertiser account → Publisher → Campaign → Transaction

Publisher reports aggregate at the publisher-per-day grain; transaction reports expose individual transactions.

## Metrics

<Note>
  **How to read the columns**
  **Data type** uses this vocabulary: Number, Currency, Percentage, Ratio, Duration, Date, Text, URL, Array, Boolean.
  **API Key** in code style like `clicks` is the literal Awin API field name. *Italic text* describes how a value is produced when it doesn't map cleanly to a single API field.
</Note>

<Note>
  Awin exposes two report shapes. Publisher-report metrics aggregate per publisher per day across commission statuses; transaction-report metrics describe a single transaction. The report type should match the analytical question being asked.
</Note>

### Clicks & traffic

| Metric      | Description                                                     | Data type | API Key       |
| ----------- | --------------------------------------------------------------- | --------- | ------------- |
| Impressions | Total impressions recorded by the publisher (publisher report). | Number    | `impressions` |
| Clicks      | Total clicks recorded by the publisher (publisher report).      | Number    | `clicks`      |

### Conversions & sales

| Metric                  | Description                                                                 | Data type | API Key                 |
| ----------------------- | --------------------------------------------------------------------------- | --------- | ----------------------- |
| Pending transactions    | Count of transactions in pending status (publisher report).                 | Number    | `pendingNo`             |
| Pending sale value      | Sale value of pending transactions.                                         | Currency  | `pendingValue`          |
| Confirmed transactions  | Count of approved transactions.                                             | Number    | `confirmedNo`           |
| Confirmed sale value    | Sale value of approved transactions.                                        | Currency  | `confirmedValue`        |
| Bonus transactions      | Count of bonus transactions.                                                | Number    | `bonusNo`               |
| Bonus sale value        | Sale value of bonus transactions.                                           | Currency  | `bonusValue`            |
| Declined transactions   | Count of declined transactions.                                             | Number    | `declinedNo`            |
| Declined sale value     | Sale value of declined transactions.                                        | Currency  | `declinedValue`         |
| Total transactions      | Total transaction count across statuses.                                    | Number    | `totalNo`               |
| Total sale value        | Total sale value across statuses.                                           | Currency  | `totalValue`            |
| Sale amount             | Sale amount associated with an individual transaction (transaction report). | Currency  | `saleAmount`            |
| Original sale amount    | Original sale amount in the source currency.                                | Currency  | `originalSaleAmount`    |
| Tracked currency amount | Amount in the originally tracked currency.                                  | Currency  | `trackedCurrencyAmount` |
| Old sale amount         | Previous sale amount when an amendment occurred.                            | Currency  | `oldSaleAmount`         |

### Commission & cost

| Metric                | Description                                                          | Data type | API Key               |
| --------------------- | -------------------------------------------------------------------- | --------- | --------------------- |
| Pending commission    | Commission for pending transactions (publisher report).              | Currency  | `pendingComm`         |
| Confirmed commission  | Commission for approved transactions.                                | Currency  | `confirmedComm`       |
| Bonus commission      | Commission for bonus transactions.                                   | Currency  | `bonusComm`           |
| Declined commission   | Commission attributable to declined transactions.                    | Currency  | `declinedComm`        |
| Total commission      | Total commission across statuses.                                    | Currency  | `totalComm`           |
| Commission amount     | Commission earned on an individual transaction (transaction report). | Currency  | `commissionAmount`    |
| Old commission amount | Previous commission amount when an amendment occurred.               | Currency  | `oldCommissionAmount` |
| Advertiser cost       | Total cost to the advertiser for the transaction.                    | Currency  | `advertiserCost`      |
| Network fee           | Awin network fee for the transaction.                                | Currency  | `networkFee`          |

## Breakdowns

### Publisher & advertiser

| Breakdown       | Description                         | API Key          |
| --------------- | ----------------------------------- | ---------------- |
| Advertiser ID   | Awin advertiser identifier.         | `advertiserId`   |
| Advertiser name | Advertiser display name.            | `advertiserName` |
| Publisher ID    | Awin publisher identifier.          | `publisherId`    |
| Publisher name  | Publisher display name.             | `publisherName`  |
| Site name       | Name of the publisher site.         | `siteName`       |
| Region          | Geographic region of the publisher. | `region`         |
| Currency        | Reporting currency.                 | `currency`       |
| Tags            | Publisher tags.                     | `tags`           |

### Transaction attributes

| Breakdown               | Description                                         | API Key            |
| ----------------------- | --------------------------------------------------- | ------------------ |
| Original transaction ID | Original Awin transaction identifier.               | `originalId`       |
| Order reference         | Order reference supplied by the advertiser.         | `orderRef`         |
| Commission status       | Pending, approved, declined, or other status.       | `commissionStatus` |
| Decline reason          | Reason a transaction was declined, when applicable. | `declineReason`    |
| Type                    | Transaction type.                                   | `type`             |
| Voucher code            | Voucher code applied, when present.                 | `voucherCode`      |
| Voucher code used       | Whether a voucher code was used.                    | `voucherCodeUsed`  |
| Campaign                | Awin campaign label.                                | `campaign`         |
| URL                     | Landing URL associated with the click.              | `url`              |
| Click date              | Date the click occurred.                            | `clickDate`        |
| Transaction date        | Date the transaction was recorded.                  | `transactionDate`  |
| Validation date         | Date the transaction was validated.                 | `validationDate`   |

### Device

| Breakdown          | Description                               | API Key             |
| ------------------ | ----------------------------------------- | ------------------- |
| Click device       | Device on which the click occurred.       | `clickDevice`       |
| Transaction device | Device on which the transaction occurred. | `transactionDevice` |

### Geography

| Breakdown          | Description                | API Key             |
| ------------------ | -------------------------- | ------------------- |
| Customer country   | Country of the customer.   | `customerCountry`   |
| Advertiser country | Country of the advertiser. | `advertiserCountry` |

### Time grouping

<Note>
  These date groupings are produced by Adriel from the underlying daily cache, not returned as Awin fields.
</Note>

| Breakdown           | Description                                                  |
| ------------------- | ------------------------------------------------------------ |
| No Grouping         | Do not break down; return one aggregated row.                |
| Auto Time Breakdown | Automatically picks the best granularity for the date range. |
| Daily               | Split reports by day.                                        |
| Weekly              | Split reports by week.                                       |
| Monthly             | Split reports by calendar month.                             |

## Limitations

* **180-day history window** — after initial connection, only the last 180 days of daily data are retrieved; earlier history is not backfilled. Rolling refreshes cover the most recent 30 days.
* **Generic data source** — Awin data appears in generic tables and does not natively combine with other connector types unless they share identical breakdowns; blending requires separate configuration.
* **Commission status is not final** — pending commissions can later move to confirmed or declined, so recent totals may change as statuses are validated upstream ([Awin API documentation](https://wiki.awin.com/index.php/API)).
* **Rate limiting** — when the Awin API returns HTTP 429, the connector surfaces the retry-after window so the connection check can be retried after the indicated wait.

## API references

* [Awin API documentation](https://wiki.awin.com/index.php/API) (verify)
* [Awin Advertiser API — publisher and transaction reports](https://wiki.awin.com/index.php/Advertiser_API) (verify)

## See also

* [How to connect Awin to Adriel](/data-sources/a-f/awin/how-to-connect) (paired how-to)