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

dimension

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

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

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

dimension

clickDate

clickDate

Date and time when the click occurred

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

commissionStatus

commissionStatus

Status of the commission, such as pending, approved, or declined

dimension

creativeId

creativeId

ID of the creative

metric

currency

currency

ISO code of the currency

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

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

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

region

region

Region code for the advertiser or transaction

dimension

salesRegions

salesRegions

List of sales regions associated with the transaction

dimension

totalComm

totalComm

Commission of all transactions

metric

totalNo

totalNo

Total number of transactions

metric

totalValue

totalValue

Value of all transactions

metric

transactionDate

transactionDate

Date and time when the transaction occurred

dimension

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