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.

API name	Adverity UI name	Description	Use in Adverity
affiliate_id	affiliate_id	A unique identifier for the affiliate (publisher) involved in the transaction or performance data.	metric
affiliate_name	affiliate_name	The name of the affiliate (publisher) associated with the transaction or performance data.	dimension
affiliate_payment_status	affiliate_payment_status	The current payment status of the commission for the affiliate, reflecting the stage of the payment process for a transaction.	dimension
aov	aov	The Average Order Value, calculated as total sales divided by the number of orders.	metric
aov_locale	aov_locale	The Average Order Value (AOV) for transactions, formatted according to a specific locale.	dimension
campaign_id	campaign_id	A unique identifier for the specific marketing campaign.	metric
campaign_name	campaign_name	The name of the marketing campaign.	dimension
click_reference	click_reference	A unique identifier or reference associated with a click that led to a transaction.	dimension
click_through_rate	click_through_rate	The Click-Through Rate, calculated as clicks divided by views, expressed as a percentage.	metric
click_through_rate_locale	click_through_rate_locale	The click-through rate (CTR) expressed as a localized percentage (click_through_percentage).	metric
clicks	clicks	The total number of clicks recorded for the period or grouping.	metric
clicks_locale	clicks_locale	The geographical or language locale associated with a specific click event or a group of clicks, as reported in the Publisher Performance data.	metric
clickthru_time	clickthru_time	The date and time when the user clicked through the affiliate link, provided as a UNIX timestamp (click_through_date).	dimension
clickthru_time_locale	clickthru_time_locale		dimension
comment	comment	Additional comments or notes related to a transaction.	dimension
commission	commission	The amount of commission earned for a transaction.	metric
commission_before_currency_conversion	commission_before_currency_conversion	The raw commission amount in its original currency before any currency conversion is applied, as reports provide unaltered currency values and conversion rates.	metric
commission_id	commission_id	A unique identifier for a specific commission generated.	dimension
commission_locale	commission_locale	The amount of commission generated from a transaction, presented in a format specific to a given locale.	dimension
commission_status	commission_status	The current status of the commission (e.g., confirmed, delayed, cancelled).	dimension
conversion_rate	conversion_rate	The Conversion Rate, calculated as sales divided by clicks, expressed as a percentage.	metric
conversion_rate_locale	conversion_rate_locale	The conversion rate expressed as a localized percentage.	metric
currency	currency	The currency code used for monetary values in the report, such as ‘EUR’ or ‘USD’.	dimension
currency_conversion_rate	currency_conversion_rate	The exchange rate applied when converting currency for transaction values or commissions.	metric
date	date	The date when a transaction or event occurred. For incremental logic, this refers to the transaction date.	dimension
date_locale	date_locale	A date associated with a transaction or activity, formatted according to a specific locale.	dimension
date_paid	date_paid	The date when the commission for the transaction was paid out, as implied by the transaction payment status.	dimension
device_os	device_os		dimension
ephc	ephc	Earnings Per Hundred Clicks (EPHC), a metric indicating the average earnings generated for every 100 clicks.	metric
ephc_locale	ephc_locale	Earnings per Hundred Clicks (EPHC) formatted according to a specific locale, often including currency symbols.	dimension
event_type	event_type	The type of event, such as CPA (Cost Per Action) or CPC (Cost Per Click).	dimension
full_date	full_date	The complete date of the event or transaction.	dimension
full_date_detail_level	full_date_detail_level	The level of granularity for the date information, such as hour, day, week, month, or summary, configurable for activity reports.	dimension
full_date_locale	full_date_locale	A complete date, potentially including time, associated with an event or transaction, formatted according to a specific locale.	dimension
hour	hour	Represents the hour of the day for which the report data is aggregated, configurable as a granularity level for activity and performance reports.	dimension
id	id	A unique identifier, often referring to a transaction ID.	metric
invoice_id	invoice_id	A unique identifier for the invoice generated for affiliate earnings.	dimension
is_adjusted	is_adjusted	Indicates whether the transaction or commission has been adjusted (e.g., updated amounts, confirmed, cancelled).	metric
landing_page	landing_page	The URL of the landing page where the user arrived after clicking the affiliate link (click_target).	dimension
link	link		dimension
locale	locale	The geographical and language locale associated with the data.	dimension
merchant	merchant	The advertiser or merchant associated with the affiliate program or transaction.	dimension
merchant_payment_status	merchant_payment_status	The current status of the payment from the merchant for a given transaction, such as ‘confirmed’, ‘delayed’, or ‘cancelled’.	dimension
month	month	The month for which the report data is aggregated, configurable as a granularity level for activity and performance reports.	dimension
n_sales	n_sales	The total number of sales (transactions) recorded.	metric
n_sales_locale	n_sales_locale	The number of sales for a period, formatted according to a specific locale.	metric
order_reference	order_reference	A unique reference number provided by the merchant for the specific order or transaction.	dimension
payment_status	payment_status	The overall payment status of the transaction.	dimension
platform	platform	The platform or device type (e.g., desktop, mobile) from which the click or transaction originated (device_type).	dimension
program_country	program_country	The country where the affiliate program is based or primarily targeted.	dimension
program_id	program_id	A unique identifier for the affiliate program.	dimension
program_name	program_name	The name of the affiliate program.	dimension
quarter	quarter	The calendar quarter in which the transaction or event occurred.	dimension
reward_type	reward_type	The type of reward or commission generated, such as Cost Per Action (CPA) or Cost Per Click (CPC).	dimension
sale	sale	The monetary value of the sale associated with the transaction.	metric
sale_before_currency_conversion	sale_before_currency_conversion	The raw sale amount in its original currency before any currency conversion is applied, as reports provide unaltered currency values and conversion rates.	metric
sale_date_time	sale_date_time	The date and time when the sale occurred (date).	dimension
sale_date_time_locale	sale_date_time_locale	The exact date and time a sale was recorded, formatted according to a specific locale.	dimension
sale_locale	sale_locale	The monetary value of the sale, presented in a format specific to a given locale.	dimension
sales	sales	The total monetary value of all sales for the period or grouping.	metric
sales_before_currency_conversion	sales_before_currency_conversion	The total raw sales amount in its original currency before any currency conversion is applied, as reports provide unaltered currency values and conversion rates.	metric
sales_locale	sales_locale	The total sales value formatted according to a specific locale, often including currency symbols.	dimension
sales_referrer	sales_referrer	The source or referrer that drove the sale, such as a specific website or ad campaign (click_source).	dimension
start_of_period	start_of_period	The beginning date of the reporting period for which data is requested.	dimension
status	status	The general status of the transaction (e.g., confirmed, delayed, cancelled).	dimension
status_change_date	status_change_date	The date when the status of the transaction last changed (status_changed_date).	dimension
status_change_date_locale	status_change_date_locale	The date when the status of a transaction (e.g., confirmed, delayed, cancelled) was last updated, formatted according to a specific locale.	dimension
totals.average_order_value	totals.average_order_value	The total average order value across all transactions in the report.	metric
totals.click_through_rate	totals.click_through_rate	The total click-through rate across all activities in the report.	metric
totals.clicks	totals.clicks	The total number of clicks across all activities in the report.	metric
totals.clicks_locale	totals.clicks_locale	The aggregated count or value of clicks attributed to a specific geographical or language locale within the Publisher Performance report.	metric
totals.commission	totals.commission	The total commission earned across all transactions in the report.	metric
totals.commission_locale	totals.commission_locale	The total commission value for the reporting period, formatted according to a specific locale, including currency symbols.	dimension
totals.conversion_rate	totals.conversion_rate	The total conversion rate across all activities in the report.	metric
totals.ephc	totals.ephc	The total earnings per hundred clicks across all activities in the report.	metric
totals.n_sales	totals.n_sales	The total number of sales across all transactions in the report.	metric
totals.n_sales_locale	totals.n_sales_locale	The total number of sales for the reporting period, formatted according to a specific locale.	metric
totals.sales	totals.sales	The total monetary value of all sales across the report.	metric
totals.sales_locale	totals.sales_locale	The total sales value for the reporting period, formatted according to a specific locale, including currency symbols.	dimension
totals.views	totals.views	The total number of views or impressions across all activities in the report.	metric
totals.views_locale	totals.views_locale	The aggregated total number of views or impressions recorded, formatted according to a specific locale.	metric
transaction_country	transaction_country	The country where the transaction occurred.	dimension
transaction_id	transaction_id	A unique identifier for the transaction.	dimension
transaction_voucher_code	transaction_voucher_code	Any voucher or coupon code applied during the transaction.	dimension
views	views	The number of views or impressions recorded for the period or grouping.	metric
views_locale	views_locale	The number of views or impressions recorded for a specific activity or publisher, formatted according to a specific locale.	metric
website	website	The website or publisher site where the associated affiliate activity or transaction originated, as reports can be drilled down to a specific site.	dimension
weekOfYear	weekOfYear	The week number within the year for which the report data is aggregated, configurable as a granularity level for activity and performance reports.	dimension
year	year	The year for which the report data is aggregated, implied by the configurable start and end dates in reports.	dimension