Skip to content
Book a demo

Connect documentation

All documentation
Documentation

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.

FieldAdverity UI nameType
DateDimension

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).

DateTimeDimension

Represents the date and time associated with an event or record, such as the transaction date or validation date, used for defining reporting periods.

advertiserCountryDimension

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.

advertiserIdMetric

The unique identifier for the advertiser.

advertiserNameDimension

The name of the advertiser associated with the transaction or report.

amendDateDimension

The date and time when the transaction was last amended.

amendReasonDimension

The reason provided for why a transaction was amended.

amendedDimension

Indicates whether the transaction has been amended (true/false).

amountMetric

The monetary value associated with the transaction, often representing the sale amount or a part of it before commission calculations.

basketProductsDimension

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.

campaignDimension

The name of the campaign through which the transaction was generated.

clickDateDimension

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

clickDeviceDimension

The device (e.g., 'Windows', 'iOS', 'Android') used by the customer when clicking the tracking link.

clickRefDimension

A custom reference value passed by the publisher in the tracking link, used for internal tracking and reporting.

clickRef2Dimension

A second custom reference value passed by the publisher in the tracking link, used for additional internal tracking.

clicksMetric

The total number of clicks generated.

commissionAmountMetric

The total commission amount earned for the transaction, including the currency.

commissionGroupCodeDimension

The unique code identifying the commission group that applies to a specific part of the transaction.

commissionGroupIdDimension

The unique ID of the commission group that applies to a specific part of the transaction.

commissionGroupNameDimension

The name of the commission group that applies to a specific part of the transaction, providing additional context to the group code.

commissionSharingPublisherIdDimension

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

commissionSharingSelectedRatePublisherIdDimension

The ID of the publisher for whom the commission sharing rate was selected for this transaction.

commissionStatusDimension

The current status of the commission (e.g., 'pending', 'approved', 'declined', 'deleted').

confirmedCommMetric

The total confirmed commission amount.

confirmedNoMetric

The total number of confirmed or approved transactions.

confirmedValueMetric

The total value of confirmed or approved transactions.

currencyDimension

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

customParametersDimension

Additional custom parameters passed by the advertiser for the transaction, available if shared with the publisher.

customerCountryDimension

The geographical region or country associated with the customer's activity, used to filter performance reports by specific markets.

declineReasonDimension

The reason provided for why a transaction was declined.

declinedCommMetric

The total declined commission amount.

declinedNoMetric

The total number of declined transactions.

declinedValueMetric

The total value of declined transactions.

idMetric

The unique identifier for the transaction.

impressionsMetric

The total number of impressions generated by creative assets.

lapseTimeMetric

The conversion time in seconds, representing the duration between the click and the transaction.

orderRefDimension

A unique reference number for the order or transaction from the advertiser's system.

originalSaleAmountMetric

The original sale amount of the transaction before any amendments or adjustments.

paidToPublisherDimension

Indicates whether the commission for this transaction has been paid to the publisher (true/false).

paymentIdDimension

The identifier for the payment associated with this transaction's commission.

pendingCommMetric

The total pending commission amount.

pendingNoMetric

The total number of pending transactions.

pendingValueMetric

The total value of pending transactions.

publisherIdMetric

The unique identifier for the publisher.

publisherNameDimension

The name of the publisher associated with the transaction or report.

publisherUrlDimension

The URL on the publisher's website where the click originated.

regionDimension

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

siteNameDimension

The name of the publisher's site where the transaction was tracked.

totalCommMetric

The total commission amount, encompassing all statuses (pending, approved, declined).

totalNoMetric

The total number of transactions.

totalValueMetric

The total value of all transactions.

trackedCurrencyAmountDimension

The monetary value of a tracked part of the transaction, including its currency.

transactionDateDimension

The date and time when the transaction was completed.

transactionDeviceDimension

The device (e.g., 'Windows', 'iOS', 'Android') used by the customer when completing the transaction.

transactionQueryIdMetric

An identifier used for querying or retrieving transaction data.

typeDimension

The type of transaction, such as 'Commission group transaction'.

urlDimension

The URL of the publisher that generated the transaction.

validationDateDimension

The date and time when the transaction was validated.

voucherCodeDimension

The specific voucher code used by the customer for the transaction.

voucherCodeUsedDimension

Indicates whether a voucher code was used for the transaction (true/false).