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 number of items per order across all conversions. |
metric |
Average Order Value |
average_order_value |
The average monetary value of an order. |
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 Rejection Rate |
conversion_rejection_rate |
The rate at which conversions are rejected, usually expressed as a percentage of total conversions. |
metric |
Country |
country |
The country associated with the transaction or user. |
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 |
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 earned by a partner for generated conversions. This is mentioned in the Analytics API documentation for reporting. |
metric |
Type |
type |
A classification or category type for an entity, such as a conversion or report. |
dimension |
advertiser_reference |
advertiser_reference |
An internal identifier used by the advertiser to reference a creative or deal. |
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 |
category |
category |
The category associated with a campaign deal. |
dimension |
click_date |
click_date |
The date when a click event occurred, typically provided in ISO-8601 format. |
dimension |
commission |
commission |
The amount of commission earned for a generated conversion, often by a partner or publisher. |
metric |
conversion_date |
conversion_date |
The date when the conversion occurred. The API uses ISO-8601 date format for various date-related fields. |
dimension |
conversion_id |
conversion_id |
A unique identifier or reference for a specific conversion event within the platform. |
dimension |
conversion_item_id |
conversion_item_id |
A unique identifier for a specific item within a conversion event. The API supports exporting conversion items reports. |
dimension |
conversion_reference |
conversion_reference |
A unique identifier or reference for a specific conversion event. |
dimension |
conversion_status |
conversion_status |
The current status of a conversion, such as approved, pending, or rejected. |
dimension |
country |
country |
The ISO-2 country code relevant to the advertiser, publisher, or campaign. |
dimension |
country_name |
country_name |
The name of the country associated with the transaction or user. |
dimension |
creative_type |
creative_type |
The type of creative or promotional material used for a marketing campaign, such as text links, banners, or HTML assets. |
dimension |
currency |
currency |
The currency in which monetary values (conversions, commissions, order values) are reported. It can also be used as a filter for reporting. |
dimension |
customer_reference |
customer_reference |
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. |
metric |
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 attributed to a specific item within a conversion. This is inferred from the existence of conversion item IDs and item-level reporting. |
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 specifically earned by a publisher (partner) for their generated conversions. The API includes endpoints to retrieve partner commissions. |
metric |
publisher_id |
publisher_id |
The unique identifier for a publisher (partner) on the platform. This is used across various partner and campaign management APIs. |
dimension |
publisher_name |
publisher_name |
The name of the publisher (partner) account. This is often referred to as ‘account_name’ for partners. |
dimension |
ref_device |
ref_device |
A unique identifier or name/type for the device used by the customer during a click or conversion event. |
dimension |
ref_partnership_model |
ref_partnership_model |
A reference to the type of partnership model, e.g., affiliate, influencer. The API provides an endpoint to list available partnership models. |
dimension |
reject_reason |
reject_reason |
The reason provided for why a conversion or other tracked event was rejected. |
dimension |
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 |
voucher_codes |
voucher_codes |
dimension |