Partnerize: Most-used fields

The table below gives information about most-used fields that you can import from Partnerize. 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
Advertiser Reference	advertiser_reference	A unique reference or identifier for the advertiser.	metric
Average Order Size	average_order_size	The average size of orders, calculated from conversion data.	metric
Average Order Value	average_order_value	The average monetary value of conversions (sales).	metric
Average ROAS	average_roas	Measures the average revenue generated for every dollar spent on advertising, indicating the efficiency of advertising campaigns.	metric
Browser Family	browser_family	The general category or family of the web browser used by the user (e.g., Chrome, Firefox, Safari).	dimension
Browser Major	browser_major	The major version number of the web browser used by the user.	metric
Browser Minor	browser_minor	The minor version number of the web browser used by the user.	metric
Browser Patch	browser_patch	The patch version number of the web browser used by the user.	metric
Category	category	The category of the product or service associated with a conversion item or a commission rule.	metric
Click Conversion Rate	click_conversion_rate	The percentage of clicks that resulted in a conversion. This metric is available in the API’s aggregated overview reports.	metric
Conversion Metric	conversion_metric	The specific metric used to define a conversion (e.g., sales, leads).	dimension
Conversion Reference	conversion_reference	A unique reference code associated with a specific conversion event.	metric
Conversion Rejection Rate	conversion_rejection_rate	The percentage of conversions that were rejected by the advertiser or network.	metric
Conversion Status	conversion_status	The current status of a conversion (e.g., pending, approved, rejected).	metric
Conversion Type	conversion_type	The classification of the conversion event (e.g., sale, lead, signup).	dimension
Country	country	The country associated with the transaction or user.	metric
Currency	currency	The currency used for monetary values in the report.	metric
Customer Reference	customer_reference	A unique reference or identifier for the customer.	metric
Customer Type	customer_type	Indicates if the customer making a conversion is new or existing.	metric
Date	Date	The date of the event or record.	dimension
Date Time	date_time	The date and time of the event or record.	dimension
Date end	Date end	The end date of the reporting period.	dimension
Date start	Date start	The start date of the reporting period.	dimension
Device	device	The type of device (e.g., mobile, tablet, desktop) used by the customer.	dimension
OS Family	os_family	The general category or family of the operating system used by the user (e.g., Windows, macOS, Android, iOS).	dimension
OS Major	os_major	The major version number of the operating system used by the user.	metric
OS Minor	os_minor	The minor version number of the operating system used by the user.	metric
OS Patch	os_patch	The patch version number of the operating system used by the user.	metric
Sku	sku	The Stock Keeping Unit (SKU) for a product.	metric
Total Clicks Converted	total_clicks_converted	The total number of clicks that resulted in a conversion.	metric
Total Partner Commission	total_partner_commission	The total commission attributed to a partner.	metric
Total ROAS	total_roas	The total return on ad spend, measuring the overall effectiveness of advertising campaigns.	metric
Traffic Source	traffic_source	The origin or channel through which users arrived (e.g., organic search, paid social).	dimension
Type	type	A classification or category type for an entity, such as a conversion or report.	dimension
Voucher Code	voucher_code	The promotional or discount code used in a conversion.	dimension
Voucher Status	voucher_status	The current status of a voucher.	dimension
campaign_id	campaign_id	A unique identifier for a marketing campaign.	dimension
campaign_name	campaign_name	The name or title of the marketing campaign.	dimension
commission	commission	The amount of commission earned for a conversion or specific item.	metric
conversion_date	conversion_date	The date when the conversion occurred.	metric
conversion_date_time	conversion_date_time	The date and time when the conversion occurred.	metric
conversion_id	conversion_id	A unique identifier for a specific conversion event.	dimension
conversion_item_id	conversion_item_id	A unique identifier for an individual item that was part of a conversion.	dimension
conversion_metric_id	conversion_metric_id	A unique identifier for a specific conversion metric.	metric
conversion_metric_name	conversion_metric_name	The name of the conversion metric being tracked (e.g., sales, leads).	metric
conversion_type_id	conversion_type_id	A unique identifier for the type of conversion.	dimension
conversion_type_name	conversion_type_name	The name of the conversion type (e.g., ‘Sale’, ‘Lead’).	dimension
country_name	country_name	The name of the country associated with the transaction or user.	dimension
device_id	device_id	A unique identifier for the device used by the customer during a click or conversion.	dimension
device_name	device_name	The name or type of the device used by the customer.	dimension
e_cpa	e_cpa	The effective cost per action.	metric
item_commission	item_commission	The commission earned on a specific item within a conversion.	metric
partner_id	partner_id	A unique identifier for the partner.	dimension
partner_name	partner_name	The name of the partner.	dimension
partnership_model_id	partnership_model_id	A unique identifier for the partnership model associated with a campaign or publisher.	dimension
partnership_model_name	partnership_model_name	The name of the partnership model (e.g., CPA, CPL, RevShare).	dimension
publisher_commission	publisher_commission	The commission earned by the publisher.	metric
publisher_id	publisher_id	A unique identifier for the publisher.	dimension
publisher_name	publisher_name	The name of the publisher.	metric
ref_partnership_model	ref_partnership_model	The identifier of the partnership model, categorizing the type of affiliate partnership (e.g., CPA, CPL, RevShare).	metric
ref_traffic_source	ref_traffic_source	A reference to the traffic source that drove the click or conversion.	metric
total_clicks	total_clicks	The total number of clicks recorded.	metric
total_commission	total_commission	The total aggregate commission earned.	metric
total_conversion_items	total_conversion_items	The total number of items included in conversions.	metric
total_conversions	total_conversions	The total number of conversions recorded.	metric
total_impressions	total_impressions	The total number of times an advertisement or content was displayed to users.	metric
total_order_value	total_order_value	The total monetary value of all confirmed orders or conversions.	metric
total_unique_clicks	total_unique_clicks	The total number of distinct clicks recorded.	metric
traffic_source_id	traffic_source_id	A unique identifier for the traffic source.	dimension
traffic_source_name	traffic_source_name	The name of the traffic source.	dimension
user_context_id	user_context_id	The identifier of the user context, providing a unique ID for a user session or interaction.	dimension
user_context_name	user_context_name	The name or description of the user context.	dimension
voucher_status_id	voucher_status_id	A unique identifier for the status of a voucher.	dimension
voucher_status_name	voucher_status_name	The name or description of the voucher’s status (e.g., valid, used, expired).	dimension