Awin Advertiser: Most-used fields

Awin Advertiser: Most-used fields#

The table below gives information about most-used fields that you can import from Awin Advertiser. 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

Campaign

Campaign

The name or identifier of the marketing campaign associated with the transaction or performance data.

dimension

Date

Date

A specific date associated with an event, such as a transaction or validation. Used for filtering reports.

dimension

DateTime

DateTime

A specific date and time associated with an event, offering a more granular timestamp than Date.

dimension

EndDate

EndDate

The end date of the reporting period for which data is requested.

dimension

StartDate

StartDate

The start date of the reporting period for which data is requested.

dimension

accountId

accountId

A unique identifier for the account, which can represent either an advertiser or publisher.

metric

accountName

accountName

The name of the account, representing either an advertiser or publisher.

dimension

accountType

accountType

The specific classification or category assigned to an Awin account (e.g., Advertiser, Publisher).

dimension

advertiserId

advertiserId

A unique identifier for the advertiser account within the Awin network. Used to scope data requests to a specific advertiser.

metric

advertiserName

advertiserName

The name of the advertiser associated with the data.

dimension

amendDate

amendDate

The date when a transaction or commission payment was validated or last updated within the Awin system.

dimension

amount

amount

The order subtotal amount after discounts, but before additional fees like taxes or delivery charges. If the transaction type is a lead, this represents the number of leads.

metric

basketProducts

basketProducts

Details of the products included in a customer’s basket for a given transaction.

dimension

bonusComm

bonusComm

The amount of bonus commission awarded for a transaction or specific publisher activity.

metric

bonusNo

bonusNo

The number of transactions or instances where bonus commission was applied.

metric

bonusValue

bonusValue

The total monetary value attributed to bonuses within the affiliate program.

metric

campaign

campaign

The name or identifier of the marketing campaign associated with the transaction or performance data.

dimension

clickDate

clickDate

The date when a user clicked on an affiliate link, leading to a potential transaction.

dimension

clickRef

clickRef

A reference or identifier for a specific click event, used for tracking and attribution.

dimension

clicks

clicks

The total number of clicks generated by an advertisement or publisher link.

metric

commissionAmount

commissionAmount

The monetary value of commission earned from a transaction.

metric

commissionGroupCode

commissionGroupCode

A code identifying the commission group that applies to a specific transaction, determining commission rates.

dimension

commissionStatus

commissionStatus

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

dimension

creativeId

creativeId

A unique identifier for a specific creative asset, such as a banner or text link, used in advertising campaigns.

metric

currency

currency

The ISO currency code of the currency used for a transaction or amount.

dimension

declineReason

declineReason

The reason provided if a transaction or commission was declined.

dimension

declinedComm

declinedComm

The total amount of commission that has been declined.

metric

declinedNo

declinedNo

The number of transactions that have been declined.

metric

declinedValue

declinedValue

The total monetary value of sales associated with declined transactions.

metric

id

id

A unique identifier for a record within the Awin platform, such as a transaction ID, publisher ID, or product ID.

dimension

impressions

impressions

The number of times an advertisement or creative asset has been displayed to users. This is a key metric in creative performance reports.

metric

lapseTime

lapseTime

The conversion time in seconds, representing the duration from the initial click to the completed transaction.

metric

networkFee

networkFee

The fee charged by the Awin network for services such as processing transactions or commissions.

dimension

orderRef

orderRef

A unique reference number for a customer order or transaction.

dimension

pendingComm

pendingComm

The total amount of commission that is currently in a pending status, awaiting validation.

metric

pendingNo

pendingNo

The number of transactions that are currently in a pending status, awaiting validation.

metric

pendingValue

pendingValue

The total monetary value of sales associated with pending transactions.

metric

primaryRegion

primaryRegion

The main geographical region associated with an advertiser or publisher account.

dimension

primaryType

primaryType

The main classification or category of a publisher within the Awin network.

dimension

publisherId

publisherId

A unique identifier for the publisher (affiliate) who generated the traffic or transaction.

metric

publisherName

publisherName

The name of the publisher (affiliate) associated with the data.

dimension

region

region

The geographical region relevant to the data, such as the region where a transaction occurred or a publisher operates. Used for filtering reports.

dimension

salesRegions

salesRegions

A list of geographical regions where an advertiser or publisher conducts sales activities.

dimension

totalComm

totalComm

The overall total amount of commission earned, including pending, approved, and declined commissions for reporting purposes.

metric

totalNo

totalNo

The overall total number of transactions recorded for reporting purposes.

metric

totalValue

totalValue

The overall total monetary value of sales or transactions for reporting purposes.

metric

transactionDate

transactionDate

The date on which a transaction took place. This is a reporting date type.

dimension

type

type

A classification or category for a record, such as the type of transaction (e.g., lead), customer acquisition type (e.g., NEW, RETURNING), or account type.

dimension

url

url

The URL to which a webhook response, containing transaction status details, will be sent.

dimension

userRole

userRole

The role assigned to a user within an Awin account, defining their permissions and access levels.

dimension

validationDate

validationDate

The date on which the commission payment for a transaction was validated. This is a reporting date type.

dimension

voucherCode

voucherCode

A promotional code used by customers to receive discounts or special offers, often tracked for attribution.

dimension