Awin Publisher: Most-used fields#
The table below gives information about most-used fields that you can import from Awin Publisher. Other fields might also be available in Adverity.
The fields that you can fetch in Adverity are updated regularly to reflect updates to data source APIs.
API name |
Adverity UI name |
Description |
Use in Adverity |
|---|---|---|---|
Date |
Date |
The date associated with a transaction or report entry. This can refer to the transaction date (when the sale occurred) or the validation date (when the sale was approved or declined). |
dimension |
DateTime |
DateTime |
Represents the date and time associated with an event or record, such as the transaction date or validation date, used for defining reporting periods. |
dimension |
advertiserCountry |
advertiserCountry |
The country where the advertiser is located or for which the advertiser’s performance data is reported. This field can be used for filtering reports by region. |
dimension |
advertiserId |
advertiserId |
The unique identifier for the advertiser. |
metric |
advertiserName |
advertiserName |
The name of the advertiser associated with the transaction or report. |
dimension |
amendDate |
amendDate |
The date and time when the transaction was last amended. |
dimension |
amendReason |
amendReason |
The reason provided for why a transaction was amended. |
dimension |
amended |
amended |
Indicates whether the transaction has been amended (true/false). |
dimension |
amount |
amount |
The monetary value associated with the transaction, often representing the sale amount or a part of it before commission calculations. |
metric |
basketProducts |
basketProducts |
A list of products included in the transaction, available if Product Level Tracking is enabled and shared by the advertiser. Each product includes details like ID, name, unit price, quantity, SKU, commission group, and category. |
dimension |
bonusComm |
bonusComm |
The total commission earned from bonus transactions. |
metric |
bonusNo |
bonusNo |
The total number of bonus transactions. |
metric |
bonusValue |
bonusValue |
The monetary value of bonus transactions. These are manually added transactions, such as bonuses, tenancies, or CPC payments, within the affiliate program. |
metric |
campaign |
campaign |
The name of the campaign through which the transaction was generated. |
dimension |
clickDate |
clickDate |
The date and time when the user clicked on the tracking link, leading to the transaction. |
dimension |
clickDevice |
clickDevice |
The device (e.g., ‘Windows’, ‘iOS’, ‘Android’) used by the customer when clicking the tracking link. |
dimension |
clickRef |
clickRef |
A custom reference value passed by the publisher in the tracking link, used for internal tracking and reporting. |
dimension |
clickRef2 |
clickRef2 |
A second custom reference value passed by the publisher in the tracking link, used for additional internal tracking. |
dimension |
clicks |
clicks |
The total number of clicks generated. |
metric |
commissionAmount |
commissionAmount |
The total commission amount earned for the transaction, including the currency. |
metric |
commissionGroupCode |
commissionGroupCode |
The unique code identifying the commission group that applies to a specific part of the transaction. |
dimension |
commissionGroupId |
commissionGroupId |
The unique ID of the commission group that applies to a specific part of the transaction. |
dimension |
commissionGroupName |
commissionGroupName |
The name of the commission group that applies to a specific part of the transaction, providing additional context to the group code. |
dimension |
commissionSharingPublisherId |
commissionSharingPublisherId |
The ID of the publisher involved in commission sharing for this transaction. |
dimension |
commissionSharingSelectedRatePublisherId |
commissionSharingSelectedRatePublisherId |
The ID of the publisher for whom the commission sharing rate was selected for this transaction. |
dimension |
commissionStatus |
commissionStatus |
The current status of the commission (e.g., ‘pending’, ‘approved’, ‘declined’, ‘deleted’). |
dimension |
confirmedComm |
confirmedComm |
The total confirmed commission amount. |
metric |
confirmedNo |
confirmedNo |
The total number of confirmed or approved transactions. |
metric |
confirmedValue |
confirmedValue |
The total value of confirmed or approved transactions. |
metric |
currency |
currency |
The ISO currency code for monetary values in the transaction, such as GBP or USD. |
dimension |
customParameters |
customParameters |
Additional custom parameters passed by the advertiser for the transaction, available if shared with the publisher. |
dimension |
customerCountry |
customerCountry |
The country of the customer who made the purchase, typically represented by a two-letter country code. |
dimension |
declineReason |
declineReason |
The reason provided for why a transaction was declined. |
dimension |
declinedComm |
declinedComm |
The total declined commission amount. |
metric |
declinedNo |
declinedNo |
The total number of declined transactions. |
metric |
declinedValue |
declinedValue |
The total value of declined transactions. |
metric |
id |
id |
The unique identifier for the transaction. |
metric |
impressions |
impressions |
The total number of impressions generated by creative assets. |
metric |
lapseTime |
lapseTime |
The conversion time in seconds, representing the duration between the click and the transaction. |
metric |
orderRef |
orderRef |
A unique reference number for the order or transaction from the advertiser’s system. |
dimension |
originalSaleAmount |
originalSaleAmount |
The original sale amount of the transaction before any amendments or adjustments. |
metric |
paidToPublisher |
paidToPublisher |
Indicates whether the commission for this transaction has been paid to the publisher (true/false). |
dimension |
paymentId |
paymentId |
The identifier for the payment associated with this transaction’s commission. |
dimension |
pendingComm |
pendingComm |
The total pending commission amount. |
metric |
pendingNo |
pendingNo |
The total number of pending transactions. |
metric |
pendingValue |
pendingValue |
The total value of pending transactions. |
metric |
publisherId |
publisherId |
The unique identifier for the publisher. |
metric |
publisherName |
publisherName |
The name of the publisher associated with the transaction or report. |
dimension |
publisherUrl |
publisherUrl |
The URL on the publisher’s website where the click originated. |
dimension |
region |
region |
The geographical region for which data is reported, such as AT or US. |
dimension |
siteName |
siteName |
The name of the publisher’s site where the transaction was tracked. |
dimension |
totalComm |
totalComm |
The total commission amount, encompassing all statuses (pending, approved, declined). |
metric |
totalNo |
totalNo |
The total number of transactions. |
metric |
totalValue |
totalValue |
The total value of all transactions. |
metric |
trackedCurrencyAmount |
trackedCurrencyAmount |
The monetary value of a tracked part of the transaction, including its currency. |
dimension |
transactionDate |
transactionDate |
The date and time when the transaction was completed. |
dimension |
transactionDevice |
transactionDevice |
The device (e.g., ‘Windows’, ‘iOS’, ‘Android’) used by the customer when completing the transaction. |
dimension |
transactionQueryId |
transactionQueryId |
An identifier used for querying or retrieving transaction data. |
metric |
type |
type |
The type of transaction, such as ‘Commission group transaction’. |
dimension |
url |
url |
The URL of the publisher that generated the transaction. |
dimension |
validationDate |
validationDate |
The date and time when the transaction was validated. |
dimension |
voucherCode |
voucherCode |
The specific voucher code used by the customer for the transaction. |
dimension |
voucherCodeUsed |
voucherCodeUsed |
Indicates whether a voucher code was used for the transaction (true/false). |
dimension |