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.
affiliate_id Metric
A unique identifier for the affiliate (publisher) involved in the transaction or performance data.
affiliate_name Dimension
The name of the affiliate (publisher) associated with the transaction or performance data.
affiliate_payment_status Dimension
The current payment status of the commission for the affiliate, reflecting the stage of the payment process for a transaction.
campaign_id Metric
A unique identifier for the specific marketing campaign.
campaign_name Dimension
The name of the marketing campaign.
click_reference Dimension
A unique identifier or reference associated with a click that led to a transaction.
clickthru_time Dimension
The date and time when the user clicked through the affiliate link, provided as a UNIX timestamp (click_through_date).
clickthru_time_locale Dimension
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.
comment Dimension
Additional notes or remarks associated with a specific transaction. This field provides supplementary information at the individual transaction level.
commission Metric
The amount of commission earned for a transaction.
commission_id Dimension
A unique identifier for a specific commission generated.
commission_locale Dimension
The amount of commission generated from a transaction, presented in a format specific to a given locale.
commission_status Dimension
The current status of the commission (e.g., confirmed, delayed, cancelled).
currency Dimension
The currency code used for monetary values in the report, such as 'EUR' or 'USD'.
date Dimension
The date when a transaction or event occurred. For incremental logic, this refers to the transaction date.
date_locale Dimension
The date of a specific event or transaction, formatted according to a given locale.
date_paid Dimension
The date when the commission for the transaction was paid out, as implied by the transaction payment status.
device_os Dimension
The operating system of the device used by the customer when a transaction occurred. This field can be captured as a custom data field within the Webgains API for enhanced reporting and insights.
event_type Dimension
The type of event, such as CPA (Cost Per Action) or CPC (Cost Per Click).
full_date Dimension
The complete date of the event or transaction.
id Metric
A unique identifier, often referring to a transaction ID.
invoice_id Dimension
A unique identifier for the invoice generated for affiliate earnings.
is_adjusted Metric
Indicates whether the transaction or commission has been adjusted (e.g., updated amounts, confirmed, cancelled).
landing_page Dimension
The URL of the landing page where the user arrived after clicking the affiliate link (click_target).
locale Dimension
The geographical and language locale associated with the data.
merchant Dimension
The advertiser or merchant associated with the affiliate program or transaction.
merchant_payment_status Dimension
The current status of the payment from the merchant for a given transaction, such as 'confirmed', 'delayed', or 'cancelled'.
order_reference Dimension
A unique reference number provided by the merchant for the specific order or transaction.
payment_status Dimension
The overall payment status of the transaction.
platform Dimension
The platform or device type (e.g., desktop, mobile) from which the click or transaction originated (device_type).
program_country Dimension
The country where the affiliate program is based or primarily targeted.
program_id Dimension
A unique identifier for the affiliate program.
program_name Dimension
The name of the affiliate program.
reward_type Dimension
The type of reward or commission generated by a transaction or event, such as Cost Per Action (CPA) or Cost Per Click (CPC).
sale Metric
The monetary value of the sale associated with the transaction.
sale_date_time Dimension
The date and time when the sale occurred (date).
sale_date_time_locale Dimension
The exact date and time a sale was recorded, formatted according to a specific locale.
sale_locale Dimension
The monetary value of the sale, presented in a format specific to a given locale.
sales_referrer Dimension
The source or referrer that drove the sale, such as a specific website or ad campaign (click_source).
status Dimension
The general status of the transaction (e.g., confirmed, delayed, cancelled).
status_change_date Dimension
The date when the status of the transaction last changed (status_changed_date).
status_change_date_locale Dimension
The date when the status of a transaction (e.g., confirmed, delayed, cancelled) was last updated, formatted according to a specific locale.
transaction_country Dimension
The country where the transaction occurred.
transaction_id Dimension
A unique identifier for the transaction.
transaction_voucher_code Dimension
Any voucher or coupon code applied during the transaction.