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.
Advertiser Referenceadvertiser_referenceMetric
A unique reference or identifier for the advertiser.
Average Order Sizeaverage_order_sizeMetric
The average number of items per order across all conversions.
Average Order Valueaverage_order_valueMetric
The average monetary value of an order.
Click Conversion Rateclick_conversion_rateMetric
The percentage of clicks that resulted in a conversion. This metric is available in the API's aggregated overview reports.
Conversion Rejection Rateconversion_rejection_rateMetric
The rate at which conversions are rejected, usually expressed as a percentage of total conversions.
CountrycountryMetric
The country associated with the transaction or user.
DateDimension
The date of the event or record.
Date Timedate_timeDimension
The date and time of the event or record.
Date endDimension
The end date of the reporting period.
Date startDimension
The start date of the reporting period.
Total Clicks Convertedtotal_clicks_convertedMetric
The total number of clicks that resulted in a conversion.
Total Partner Commissiontotal_partner_commissionMetric
The total commission earned by a partner for generated conversions. This is mentioned in the Analytics API documentation for reporting.
TypetypeDimension
A classification or category type for an entity, such as a conversion or report.
advertiser_referenceDimension
An internal identifier used by the advertiser to reference a creative or deal.
campaign_idDimension
A unique identifier for a marketing campaign.
campaign_nameDimension
The name or title of the marketing campaign.
categoryDimension
The category associated with a campaign deal.
click_dateDimension
This field indicates the date when a click event occurred. It is used for tracking and reporting on traffic generation.
commissionMetric
The amount of commission earned for a generated conversion, often by a partner or publisher.
conversion_dateDimension
The date when the conversion occurred. The API uses ISO-8601 date format for various date-related fields.
conversion_idDimension
A unique identifier or reference for a specific conversion event within the platform.
conversion_item_idDimension
A unique identifier for a specific item within a conversion event. The API supports exporting conversion items reports.
conversion_referenceDimension
A unique identifier or reference for a specific conversion event.
conversion_statusDimension
The current status of a conversion, such as approved, pending, or rejected.
countryDimension
The ISO-2 country code relevant to the advertiser, publisher, or campaign.
country_nameDimension
The name of the country associated with the transaction or user.
creative_typeDimension
The type of creative or promotional material used for a marketing campaign, such as text links, banners, or HTML assets.
currencyDimension
The currency in which monetary values (conversions, commissions, order values) are reported. It can also be used as a filter for reporting.
customer_referenceMetric
A unique identifier for a campaign within the Partnerize platform. This reference is used for tracking and reporting purposes, allowing users to differentiate between various campaigns.
customer_typeDimension
Represents the category or type of the customer associated with a conversion or other tracked event within the Partnerize platform. This field helps in classifying customers for reporting and analysis.
device_idDimension
A unique identifier for the device used by the customer during a click or conversion.
device_nameDimension
The name or type of the device used by the customer.
e_cpaMetric
The effective cost per action.
item_commissionMetric
The commission attributed to a specific item within a conversion. This is inferred from the existence of conversion item IDs and item-level reporting.
partner_idDimension
A unique identifier for the partner.
partner_nameDimension
The name of the partner.
partnership_model_idDimension
A unique identifier for the partnership model associated with a campaign or publisher.
partnership_model_nameDimension
The name of the partnership model (e.g., CPA, CPL, RevShare).
publisher_commissionMetric
The commission specifically earned by a publisher (partner) for their generated conversions. The API includes endpoints to retrieve partner commissions.
publisher_idDimension
The unique identifier for a publisher (partner) on the platform. This is used across various partner and campaign management APIs.
publisher_nameDimension
The name of the publisher (partner) account. This is often referred to as 'account_name' for partners.
ref_deviceDimension
A unique identifier or name/type for the device used by the customer during a click or conversion event.
ref_partnership_modelDimension
A reference to the type of partnership model, e.g., affiliate, influencer. The API provides an endpoint to list available partnership models.
reject_reasonDimension
The reason provided for why a conversion or other tracked event was rejected.
source_refererDimension
The URL of the web page or advertising placement from which a user clicked a tracking link, leading to a click or conversion. It indicates the originating traffic source.
total_clicksMetric
The total number of clicks recorded.
total_commissionMetric
The total aggregate commission earned.
total_conversion_itemsMetric
The total number of items included in conversions.
total_conversionsMetric
The total number of conversions recorded.
total_impressionsMetric
The total number of times an advertisement or content was displayed to users.
total_order_valueMetric
The total monetary value of all confirmed orders or conversions.
total_unique_clicksMetric
The total number of distinct clicks recorded.
traffic_source_idDimension
A unique identifier for the traffic source.
traffic_source_nameDimension
The name of the traffic source.
voucher_codesDimension
A unique code, such as a coupon or promotional code, offered by a brand to customers to apply discounts or promotions to transactions.