Awin Publisher: Most-used fields

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

A generic date field, typically representing the date relevant to the specific report or transaction context (e.g., transaction, validation, or amendment date).

dimension

DateTime

DateTime

A generic date and time field, typically representing the date and time relevant to the specific report or transaction context.

dimension

EndDate

EndDate

The end date for the reporting period or transaction query.

dimension

StartDate

StartDate

The start date for the reporting period or transaction query.

dimension

advertiserCountry

advertiserCountry

dimension

advertiserId

advertiserId

The unique identifier for the advertiser.

metric

advertiserName

advertiserName

The name of the advertiser.

dimension

amendDate

amendDate

The date when a transaction was last amended. This is used when filtering transactions by ‘amendment’ dateType.

dimension

amendReason

amendReason

dimension

amended

amended

dimension

amount

amount

The order subtotal amount for a transaction, after discounts but before additional fees like taxes or delivery charges. This may also refer to a generic sale amount.

metric

basketProducts

basketProducts

A list of products included in the transaction’s basket, available when product-level tracking is enabled.

dimension

bonusComm

bonusComm

The commission earned from bonus transactions.

metric

bonusNo

bonusNo

The number of bonus transactions.

metric

campaign

campaign

The name of the campaign associated with the transaction.

dimension

clickDate

clickDate

The date and time when the customer clicked on the tracking link, leading to the transaction.

dimension

clickDevice

clickDevice

dimension

clickRef

clickRef

A custom reference parameter (ClickRef1) passed by the publisher to track clicks and provide additional information for the transaction.

dimension

clickRef2

clickRef2

A secondary custom reference parameter (ClickRef2) passed by the publisher for additional tracking information.

dimension

clicks

clicks

The total number of clicks generated.

metric

commissionAmount

commissionAmount

The amount of commission generated by the transaction.

metric

commissionGroupCode

commissionGroupCode

The unique code for the commission group to which the transaction belongs.

dimension

commissionGroupId

commissionGroupId

The unique identifier for the commission group.

metric

commissionGroupName

commissionGroupName

The name of the commission group.

dimension

commissionSharingPublisherId

commissionSharingPublisherId

The ID of the publisher involved in commission sharing for this transaction.

dimension

commissionSharingSelectedRatePublisherId

commissionSharingSelectedRatePublisherId

The ID of the publisher whose commission rate was selected for this transaction in a commission sharing scenario.

dimension

commissionStatus

commissionStatus

The current status of the commission, such as pending, approved, or declined.

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

creativeId

creativeId

The unique identifier for the creative asset used in a campaign.

metric

creativeName

creativeName

The name of the creative asset.

dimension

currency

currency

The ISO currency code for monetary values in the transaction, such as GBP or USD.

dimension

customParameters

customParameters

Additional custom parameters passed with the transaction, allowing for shared information between publishers and advertisers.

dimension

customerCountry

customerCountry

The country of the customer who made the purchase.

dimension

declineReason

declineReason

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.

dimension

impressions

impressions

The total number of impressions generated by creative assets.

metric

lapseTime

lapseTime

The conversion time for the transaction, representing the time taken from click to conversion.

metric

orderRef

orderRef

The reference ID for the booking or order, used to share information between publishers and advertisers.

dimension

originalSaleAmount

originalSaleAmount

dimension

paidToPublisher

paidToPublisher

dimension

paymentId

paymentId

metric

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.

dimension

publisherUrl

publisherUrl

The URL associated with the publisher or the transaction source.

dimension

region

region

The geographical region for which data is reported, such as AT or US.

dimension

siteName

siteName

The name of the website or site from which the transaction originated.

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

dimension

transactionDate

transactionDate

The date and time when the transaction took place. This is the default date type for filtering transactions.

dimension

transactionDevice

transactionDevice

dimension

transactionQueryId

transactionQueryId

The identifier for a transaction query.

metric

type

type

The type of transaction, such as Sale, Lead, Bonus, or Mobile App Install.

dimension

url

url

The URL related to the transaction or the publisher.

dimension

validationDate

validationDate

The date when the commission payment for the transaction was validated. This is used when filtering transactions by ‘validation’ dateType.

dimension

voucherCode

voucherCode

The voucher code used in the transaction, if applicable.

dimension

voucherCodeUsed

voucherCodeUsed

Indicates whether a voucher code was used for the transaction.

dimension