Awin Advertiser#
The table below gives information about all the data fields that you can import from Awin Advertiser.
The fields that you can fetch in Adverity are updated regularly to reflect updates to data source APIs. As a result, the fields shown here may not be the same as the fields available in Adverity. If you notice a difference between this documentation and the fields you see in Adverity, please contact your Adverity account manager for more information.
To see the fields you can collect from another data source, go back to the Available fields in Adverity overview.
Field UI name below refers to how the name displayed in Adverity.
Field UI name |
Field API name |
Description |
Use in Adverity |
---|---|---|---|
Date |
Date |
Date of the transaction or event in the report |
dimension |
DateTime |
DateTime |
Date and time of the transaction or event in the report |
dimension |
EndDate |
EndDate |
End date of the reporting period |
dimension |
StartDate |
StartDate |
Start date of the reporting period |
dimension |
accountId |
accountId |
ID of the account, as known from the frontend URLs |
metric |
accountName |
accountName |
Programme name for an advertiser and company name for a publisher |
dimension |
accountType |
accountType |
Type of the account, can be either publisher or advertiser |
dimension |
advertiserCost |
advertiserCost |
Cost incurred by the advertiser for the transaction |
dimension |
advertiserCountry |
advertiserCountry |
Country of the advertiser account |
dimension |
advertiserId |
advertiserId |
ID of the advertiser, corresponding with advertiserName |
metric |
advertiserName |
advertiserName |
Name of the advertiser, corresponding with advertiserId |
dimension |
amendDate |
amendDate |
Date and time the transaction was amended |
dimension |
amendReason |
amendReason |
Reason for the amendment of the transaction |
dimension |
amended |
amended |
Indicates if the transaction has been amended |
dimension |
amount |
amount |
Amount of commission or payment, only available for fixed type |
metric |
basketProducts |
basketProducts |
JSON array of products in the basket for the transaction |
dimension |
bonusComm |
bonusComm |
Commission of the bonus transactions |
metric |
bonusNo |
bonusNo |
Number of bonus transactions |
metric |
bonusValue |
bonusValue |
Value of the bonus transactions |
metric |
campaign |
campaign |
Campaign identifier used in the transaction, matches the &campaign= parameter |
metric |
clickDate |
clickDate |
Date and time when the click occurred |
dimension |
clickDevice |
clickDevice |
Device type used for the click, such as desktop or mobile |
dimension |
clickRef |
clickRef |
Custom click reference parameter set by the advertiser |
dimension |
clicks |
clicks |
Number of clicks |
metric |
commissionAmount |
commissionAmount |
Amount of commission for the transaction |
metric |
commissionGroupCode |
commissionGroupCode |
Code of the commission group, not necessarily unique across advertisers |
dimension |
commissionGroupId |
commissionGroupId |
ID of the commission group, unique even across advertisers |
metric |
commissionGroupName |
commissionGroupName |
Name of the commission group, can provide additional information to the groupCode |
dimension |
commissionSharingPublisherId |
commissionSharingPublisherId |
Publisher ID for commission sharing rules |
dimension |
commissionSharingSelectedRatePublisherId |
commissionSharingSelectedRatePublisherId |
Publisher ID for selected commission sharing rate |
metric |
commissionStatus |
commissionStatus |
Status of the commission, such as pending, approved, or declined |
dimension |
confirmedComm |
confirmedComm |
Commission of the confirmed transactions |
metric |
confirmedNo |
confirmedNo |
Number of confirmed transactions |
metric |
confirmedValue |
confirmedValue |
Value of confirmed transactions |
metric |
creativeId |
creativeId |
ID of the creative |
metric |
creativeName |
creativeName |
Name of the creative |
dimension |
currency |
currency |
ISO code of the currency |
dimension |
customParameters |
customParameters |
Custom parameters provided by the advertiser for tracking |
dimension |
customerAcquisition |
customerAcquisition |
Indicates whether the transaction resulted in a new customer acquisition |
dimension |
customerCountry |
customerCountry |
Country of the customer associated with the transaction |
dimension |
declineReason |
declineReason |
Reason for declining the transaction |
dimension |
declinedComm |
declinedComm |
Commission of declined transactions |
metric |
declinedNo |
declinedNo |
Number of declined transactions |
metric |
declinedValue |
declinedValue |
Value of declined transactions |
metric |
id |
id |
Unique identifier for the transaction or record |
dimension |
impressions |
impressions |
Number of impressions |
metric |
ipHash |
ipHash |
Hashed value of the IP address associated with the transaction |
metric |
lapseTime |
lapseTime |
Time in seconds between click and transaction |
metric |
networkFee |
networkFee |
Network fee charged for the transaction, if applicable |
dimension |
orderRef |
orderRef |
Reference number for the order associated with the transaction |
metric |
originalSaleAmount |
originalSaleAmount |
Original sale amount before any adjustments or amendments |
dimension |
paidToPublisher |
paidToPublisher |
Indicates if the commission has been paid to the publisher |
dimension |
paymentId |
paymentId |
Unique identifier for the payment associated with the transaction |
metric |
pendingComm |
pendingComm |
Commissions of the pending transactions |
metric |
pendingNo |
pendingNo |
Number of pending transactions |
metric |
pendingValue |
pendingValue |
Value of the pending transactions |
metric |
primaryRegion |
primaryRegion |
Primary region of the programme, including name and country code |
dimension |
primaryType |
primaryType |
Primary type of the commission, such as fix or percentage |
dimension |
publisherId |
publisherId |
ID of the publisher, corresponding with publisherName |
metric |
publisherName |
publisherName |
Name of the publisher, corresponding with publisherId |
dimension |
publisherUrl |
publisherUrl |
URL of the publisher’s website |
dimension |
region |
region |
Region code for the advertiser or transaction |
dimension |
salesRegions |
salesRegions |
List of sales regions associated with the transaction |
dimension |
siteName |
siteName |
Name of the site associated with the transaction or publisher |
dimension |
tagName |
tagName |
Tag name of the creative, used by the advertiser to group creatives |
dimension |
tags |
tags |
Tags associated with the transaction or creative |
dimension |
totalComm |
totalComm |
Commission of all transactions |
metric |
totalNo |
totalNo |
Total number of transactions |
metric |
totalValue |
totalValue |
Value of all transactions |
metric |
trackedCurrencyAmount |
trackedCurrencyAmount |
Amount in the tracked currency for the transaction |
dimension |
trackedParts |
trackedParts |
Parts of the transaction that were tracked |
dimension |
transactionDate |
transactionDate |
Date and time when the transaction occurred |
dimension |
transactionDevice |
transactionDevice |
Device used for the transaction, such as desktop or mobile |
dimension |
transactionQueryId |
transactionQueryId |
Query ID associated with the transaction for tracking purposes |
metric |
type |
type |
Type of commission or transaction, such as fix or percentage |
dimension |
url |
url |
URL associated with the transaction or creative |
dimension |
userRole |
userRole |
The role your user account has for the account |
dimension |
validationDate |
validationDate |
Date when the transaction was validated |
dimension |
voucherCode |
voucherCode |
Voucher code used in the transaction, if applicable |
dimension |
voucherCodeUsed |
voucherCodeUsed |
Indicates if a voucher code was used in the transaction |
dimension |