Skip to content
Book a demo

Connect documentation

All documentation
Documentation

Webgains: Most-used fields

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

A unique identifier for the affiliate (publisher) involved in the transaction or performance data.

affiliate_nameDimension

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

affiliate_payment_statusDimension

The current payment status of the commission for the affiliate, reflecting the stage of the payment process for a transaction.

campaign_idMetric

A unique identifier for the specific marketing campaign.

campaign_nameDimension

The name of the marketing campaign.

click_referenceDimension

A unique identifier or reference associated with a click that led to a transaction.

clickthru_timeDimension

The date and time when the user clicked through the affiliate link, provided as a UNIX timestamp (click_through_date).

clickthru_time_localeDimension

The date and time when a user clicked through an affiliate link, presented in a localized format. This corresponds to the event of a click on an advertisement or promotional material.

commentDimension

Additional notes or remarks associated with a specific transaction. This field provides supplementary information at the individual transaction level.

commissionMetric

The amount of commission earned for a transaction.

commission_idDimension

A unique identifier for a specific commission generated.

commission_localeDimension

The amount of commission generated from a transaction, presented in a format specific to a given locale.

commission_statusDimension

The current status of the commission (e.g., confirmed, delayed, cancelled).

currencyDimension

The currency code used for monetary values in the report, such as 'EUR' or 'USD'.

customer_idDimension

A unique identifier for the customer associated with the transaction, if available. For example, 'CUSTOMER123'.

dateDimension

The date when a transaction or event occurred. For incremental logic, this refers to the transaction date.

date_localeDimension

The date of a specific event or transaction, formatted according to a given locale.

date_paidDimension

The date when the commission for the transaction was paid out, as implied by the transaction payment status.

device_osDimension

The operating system of the device used for the transaction. This field is collected as part of additional custom tracking data.

event_typeDimension

The type of event, such as CPA (Cost Per Action) or CPC (Cost Per Click).

full_dateDimension

The complete date of the event or transaction.

idMetric

A unique identifier, often referring to a transaction ID.

invoice_idDimension

A unique identifier for the invoice generated for affiliate earnings.

is_adjustedMetric

Indicates whether the transaction or commission has been adjusted (e.g., updated amounts, confirmed, cancelled).

landing_pageDimension

The URL of the landing page where the user arrived after clicking the affiliate link (click_target).

localeDimension

The geographical and language locale associated with the data.

merchantDimension

The advertiser or merchant associated with the affiliate program or transaction.

merchant_payment_statusDimension

The current status of the payment from the merchant for a given transaction, such as 'confirmed', 'delayed', or 'cancelled'.

order_referenceDimension

A unique reference number provided by the merchant for the specific order or transaction.

payment_statusDimension

The overall payment status of the transaction.

platformDimension

The platform or device type (e.g., desktop, mobile) from which the click or transaction originated (device_type).

program_countryDimension

The country where the affiliate program is based or primarily targeted.

program_idDimension

A unique identifier for the affiliate program.

program_nameDimension

The name of the affiliate program.

reward_typeDimension

The type of reward or commission generated by a transaction or event, such as Cost Per Action (CPA) or Cost Per Click (CPC).

saleMetric

The monetary value of the sale associated with the transaction.

sale_date_timeDimension

The date and time when the sale occurred (date).

sale_date_time_localeDimension

The exact date and time a sale was recorded, formatted according to a specific locale.

sale_localeDimension

The monetary value of the sale, presented in a format specific to a given locale.

sales_referrerDimension

The source or referrer that drove the sale, such as a specific website or ad campaign (click_source).

statusDimension

The general status of the transaction (e.g., confirmed, delayed, cancelled).

status_change_dateDimension

The date when the status of the transaction last changed (status_changed_date).

status_change_date_localeDimension

The date when the status of a transaction (e.g., confirmed, delayed, cancelled) was last updated, formatted according to a specific locale.

transaction_countryDimension

The country where the transaction occurred.

transaction_idDimension

A unique identifier for the transaction.

transaction_voucher_codeDimension

Any voucher or coupon code applied during the transaction.