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
Hour	hour	The hour of the day, used for reporting data at an hourly granularity.	dimension
affiliate_id	affiliate_id	The unique identifier for the affiliate (publisher) account.	dimension
affiliate_name	affiliate_name	The name of the affiliate (publisher) associated with the performance data.	dimension
affiliate_payment_status	affiliate_payment_status	The status of the payment made or due to the affiliate for their generated commissions.	dimension
aov	aov	The Average Order Value (AOV) for sales generated within a reporting period.	metric
aov_locale	aov_locale	The average order value in the local currency.	dimension
campaign_id	campaign_id	The unique identifier for the campaign. This field can be used to filter results.	dimension
campaign_name	campaign_name	The name of the campaign associated with the transaction or activity.	dimension
click_reference	click_reference	A unique reference string associated with a specific click event.	dimension
click_through_rate	click_through_rate	The percentage of impressions that resulted in a click, also known as click-through percentage.	metric
click_through_rate_locale	click_through_rate_locale	The click-through rate, expressed as a percentage, for a specific locale.	metric
clicks	clicks	The total number of clicks recorded for an activity or program within a reporting period.	metric
clicks_locale	clicks_locale	The total number of clicks for a specific locale.	metric
clickthru_time	clickthru_time	The timestamp indicating when the click-through occurred.	dimension
clickthru_time_locale	clickthru_time_locale	The date and time when a click-through event occurred, adjusted to the local timezone.	dimension
comment	comment	A comment or reason associated with a transaction change or status.	dimension
commission	commission	The total commission amount generated for a transaction or within a reporting period.	metric
commission_before_currency_conversion	commission_before_currency_conversion	The commission amount in its original transaction currency, before any potential conversion to a different reporting currency for combined reports.	metric
commission_id	commission_id	A unique identifier for the commission generated by a transaction.	dimension
commission_locale	commission_locale	The total commission amount in the local currency.	dimension
commission_status	commission_status	The current status of a commission (e.g., pending, approved, paid).	dimension
conversion_rate	conversion_rate	The rate at which clicks resulted in a successful conversion (e.g., a sale).	metric
conversion_rate_locale	conversion_rate_locale	The conversion rate for a specific locale.	metric
currency	currency	The currency code (e.g., GBP) for all financial amounts in the report.	dimension
currency_conversion_rate	currency_conversion_rate	The rate used to convert transaction or commission values between different currencies.	metric
date	date	The date of the event, such as a transaction date or the start/end date of a reporting period.	dimension
date_locale	date_locale	The date of the transaction, formatted for a specific locale.	dimension
date_paid	date_paid	The date when the transaction was paid. This is derived from the transaction status indicating payment.	dimension
ephc	ephc	Earnings Per Hundred Clicks (EPHC), representing the average earnings for every hundred clicks.	metric
ephc_locale	ephc_locale	Earnings per hundred clicks (EPHC) for a specific locale.	dimension
event_type	event_type	The type of event (e.g., CPA for Cost Per Action, CPC for Cost Per Click) associated with the activity or transaction.	dimension
full_date	full_date	The full date and time when the transaction was created, as a UNIX timestamp.	dimension
full_date_detail_level	full_date_detail_level	The level of granularity for date-related data in a report (e.g., hour, day, week, month, summary).	dimension
full_date_locale	full_date_locale	The full date and time when the transaction was created, formatted for a specific locale.	dimension
id	id	A unique identifier, often referring to a transaction ID.	dimension
invoice_id	invoice_id	The unique identifier of the invoice associated with the transaction payment.	dimension
is_adjusted	is_adjusted	A flag indicating whether a transaction or commission has been adjusted (e.g., amount updated, confirmed, or cancelled).	metric
landing_page	landing_page	The URL of the landing page where the user was redirected to after clicking a tracking link.	dimension
locale	locale	The geographical or language setting associated with the data, such as for a specific program or publisher.	dimension
merchant	merchant	The name of the merchant or advertiser associated with the program.	dimension
merchant_payment_status	merchant_payment_status	The payment status of the transaction as reported by the merchant (e.g., pending, approved, cancelled).	dimension
month	month	The month, used for reporting data at a monthly granularity.	dimension
n_sales	n_sales	The total count of sales or conversions within a reporting period.	metric
n_sales_locale	n_sales_locale	The number of sales for a specific locale.	metric
order_reference	order_reference	The unique reference number assigned to an order or transaction.	dimension
payment_status	payment_status	The general status of a payment, indicating its current stage in the payment process.	dimension
platform	platform		dimension
program_country	program_country	The country in which the affiliate program operates.	dimension
program_id	program_id	The unique identifier for the affiliate program. This field can be used to filter results.	dimension
program_name	program_name	The name of the affiliate program.	dimension
quarter	quarter		dimension
sale	sale	The monetary value of a single sale or transaction.	metric
sale_before_currency_conversion	sale_before_currency_conversion	The sale amount in its original transaction currency, before any potential conversion to a different reporting currency for combined reports.	metric
sale_date_time	sale_date_time	The date and time when the sale occurred.	dimension
sale_date_time_locale	sale_date_time_locale	The date and time of the sale, formatted for a specific locale.	dimension
sale_locale	sale_locale	The total sale amount in the local currency.	dimension
sales	sales	The total monetary value of all sales within a reporting period.	metric
sales_before_currency_conversion	sales_before_currency_conversion	The total sales amount in its original transaction currency, before any potential conversion to a different reporting currency for combined reports.	metric
sales_locale	sales_locale	The total sales amount in the local currency.	dimension
sales_referrer	sales_referrer	The referring URL from where the sale originated.	dimension
start_of_period	start_of_period	The timestamp marking the beginning of the reporting period.	dimension
status	status	The current status of a transaction or other entity. For transactions, examples include ‘paid’, ‘cleared_for_payment’, ‘awaiting_payment’.	metric
status_change_date	status_change_date	The date and time when the status of an entity, such as a transaction, last changed.	dimension
status_change_date_locale	status_change_date_locale	The date when the transaction status last changed, formatted for a specific locale.	dimension
totals.average_order_value	totals.average_order_value	The aggregated average order value across all reported items.	metric
totals.click_through_rate	totals.click_through_rate	The aggregated click-through rate across all reported items.	metric
totals.clicks	totals.clicks	The aggregated total number of clicks across all reported items.	metric
totals.clicks_locale	totals.clicks_locale	The total number of clicks recorded for a specific locale.	metric
totals.commission	totals.commission	The aggregated total commission earned across all reported items.	metric
totals.commission_locale	totals.commission_locale	The total value of commissions generated for a specific locale, often presented in the local currency.	dimension
totals.conversion_rate	totals.conversion_rate	The aggregated total conversion rate across all reported items.	metric
totals.ephc	totals.ephc	The aggregated Earnings Per Hundred Clicks (EPHC) across all reported items.	metric
totals.n_sales	totals.n_sales	The aggregated total number of sales across all reported items.	metric
totals.n_sales_locale	totals.n_sales_locale	The total number of sales recorded for a specific locale.	metric
totals.sales	totals.sales	The aggregated total sales value across all reported items.	metric
totals.sales_locale	totals.sales_locale	The total monetary value of sales recorded for a specific locale.	dimension
totals.views	totals.views	The aggregated total number of views or impressions across all reported items.	metric
totals.views_locale	totals.views_locale	The total number of views or impressions recorded for a specific locale.	metric
transaction_country	transaction_country	The country where the transaction occurred.	dimension
transaction_id	transaction_id	The unique identifier for a specific transaction.	dimension
transaction_voucher_code	transaction_voucher_code	The voucher code used in the transaction.	dimension
views	views	The total number of impressions or views recorded.	metric
views_locale	views_locale	The total number of views or impressions for a specific locale.	metric
weekOfYear	weekOfYear	The week number within the year, used for reporting data at a weekly granularity.	dimension
year	year		metric