Avocet: Most-used fields

The table below gives information about most-used fields that you can import from Avocet. 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	Description	Use in Adverity
action	Represents a specific user interaction or event associated with an ad, such as a click, conversion, or engagement.	dimension
app_bundle	The unique identifier or bundle ID of the mobile application where an ad was displayed.	dimension
attribution_mode	The method used to assign credit for a conversion or other event to a particular ad touchpoint.	dimension
billing_period_name	The descriptive name of the billing period for which the data is reported.	dimension
billing_period_ref_id	A unique reference identifier for the billing period.	dimension
brand_name	The name of the brand associated with the advertising campaign. This data is available in performance reports and can be retrieved via the /brand API endpoint.	dimension
brand_ref_id	A unique identifier for the brand associated with the advertising campaign.	dimension
browser_name	The name of the web browser used by the user when viewing the advertisement.	dimension
city	The city from which the ad impression or event originated, used for geographic targeting and reporting.	dimension
clicks	The total number of times users interacted with and clicked on the advertisement.	metric
connection_type_name	The name of the user’s internet connection type (e.g., Wi-Fi, 4G, DSL) at the time of the ad interaction.	dimension
connection_type_ref_id	A unique reference identifier for the internet connection type.	dimension
conversion_priority	The priority level assigned to a specific conversion event, often used in optimization strategies.	dimension
country	The country from which the ad impression or event originated, used for geographic targeting and reporting.	dimension
country_subdivision	A geographic subdivision within a country, such as a state, province, or region.	dimension
creative_code	A unique code or identifier for a specific ad creative used in a campaign.	dimension
creative_dimensions	The pixel dimensions (e.g., 300x250) of the ad creative displayed.	dimension
creative_height	The height of the creative asset in pixels.	dimension
creative_name	The name of the creative asset used in the advertisement.	dimension
creative_ref_id	A unique identifier for the creative asset used in the advertisement.	dimension
creative_width	The width of the creative asset in pixels.	dimension
cross_device	Indicates whether a user’s journey or conversion involved interactions across multiple devices.	dimension
ctr	The Click-Through Rate, calculated as the number of clicks divided by the number of impressions, expressed as a percentage.	metric
currency_code	The ISO 4217 code for the currency used in financial transactions (e.g., ‘USD’ for United States Dollar).	dimension
currency_name	The full name of the currency used for financial reporting.	dimension
currency_ref_id	A unique reference identifier for the currency.	dimension
currency_symbol	The symbol representing the currency (e.g., ‘$’, ‘€’).	dimension
cv_rate	The Conversion Rate, calculated as the number of conversions divided by the number of impressions or clicks, expressed as a percentage.	metric
day_of_week	The day of the week (e.g., Monday, Tuesday) when the ad interaction or event occurred.	dimension
device_type_name	The category of device on which the advertisement was displayed (e.g., desktop, mobile, tablet). This field can also be used as a filter in report configuration.	dimension
device_type_ref_id	A unique reference identifier for the type of device used (e.g., mobile, desktop, tablet).	dimension
domain	The internet domain associated with an ad impression, such as the publisher’s domain or the referring domain.	dimension
ecpa	The Effective Cost Per Action (or Acquisition), calculated as the total cost divided by the number of conversions.	metric
ecpc	The Effective Cost Per Click, calculated as the total cost divided by the number of clicks.	metric
ecpm	The Effective Cost Per Mille (thousand impressions), calculated as the total cost divided by the number of impressions, multiplied by 1000.	metric
erpa	The Effective Revenue Per Action, calculated as the total revenue generated divided by the number of actions or conversions.	metric
erpc	The Effective Revenue Per Click, calculated as the total revenue generated divided by the number of clicks.	metric
erpm	The Effective Revenue Per Mille (thousand impressions), calculated as the total revenue generated divided by the number of impressions, multiplied by 1000.	metric
events	The total count of specified events that occurred within the reporting period.	metric
fee	A specific fee amount associated with advertising activities.	metric
fee_currency_name	The name of the currency in which the fee is expressed.	dimension
fee_currency_symbol	The symbol of the currency in which the fee is expressed.	dimension
fee_ecpm	The fee calculated on an Effective Cost Per Mille (thousand impressions) basis.	metric
fee_usd	The fee amount converted to US Dollars.	metric
fee_usd_ecpm	The fee in US Dollars calculated on an Effective Cost Per Mille (thousand impressions) basis.	metric
fees	The total amount of all fees incurred for the advertising activities.	metric
hour_of_day	The hour of the day (0-23) when the ad interaction or event occurred, used for granular time-based reporting.	dimension
hour_of_week	The hour within the week (0-167) when the ad interaction or event occurred.	dimension
impression_type	The specific type of ad impression (e.g., display, video, native).	dimension
impressions	The total number of times an advertisement was displayed to users.	metric
insertion_order_name	The name of the insertion order, which is a contractual agreement that outlines the terms of an advertising campaign.	dimension
insertion_order_ref_id	A unique identifier for the insertion order.	dimension
inventory_ref_id	A unique reference identifier for the ad inventory where the ad was displayed.	dimension
inventory_source_name	The name of the source or publisher providing the ad inventory.	dimension
inventory_source_ref_id	A unique reference identifier for the inventory source.	dimension
language_name	The name of the language associated with the user or the content where the ad was served.	dimension
language_ref_id	A unique reference identifier for the language.	dimension
measurable_impressions	The number of impressions that were measurable for viewability according to industry standards.	metric
month	The month of the year when the ad interaction or event occurred.	dimension
month_of_year	The numerical representation of the month within the year (1-12).	dimension
operating_system_name	The name of the operating system (e.g., iOS, Android, Windows) of the device on which the ad was displayed.	dimension
operating_system_ref_id	A unique reference identifier for the operating system.	dimension
order_revenue	The total revenue generated from orders attributed to advertising efforts.	metric
page_domain	The internet domain of the webpage where the ad was displayed.	dimension
page_position_name	The descriptive name of the ad’s position on a webpage (e.g., ‘Above the Fold’, ‘Sidebar’).	dimension
page_position_ref_id	A unique reference identifier for the ad’s position on a page.	dimension
post_click_conversions	The number of conversions attributed to a user clicking on an advertisement.	metric
post_click_cv_rate	The post-click conversion rate, measuring the percentage of users who convert after clicking on an ad.	metric
post_code	The postal code associated with the user’s location, used for geographic targeting and reporting.	dimension
post_view_conversions	The number of conversions attributed to a user viewing an advertisement without clicking it.	metric
post_view_cv_rate	The post-view conversion rate, measuring the percentage of users who convert after seeing an ad but not clicking on it.	metric
post_viewable_conversions	The number of conversions attributed to viewable ad impressions.	metric
post_viewable_cv_rate	The post-viewable conversion rate, measuring the percentage of users who convert after a viewable ad impression.	metric
referer_domain	The domain of the webpage that referred the user to the page where the ad was displayed.	dimension
request_domain	The internet domain from which the ad request originated.	dimension
revenue	The total gross revenue generated from advertising activities.	metric
serving_fees	Fees specifically incurred for the delivery or serving of advertisements.	metric
source_device_type_name	The name of the device type (e.g., ‘Mobile’, ‘Desktop’, ‘Tablet’) from which the ad request originated.	dimension
source_device_type_ref_id	A unique reference identifier for the source device type.	dimension
supply_type_name	The name of the supply channel or inventory type (e.g., ‘Web’, ‘In-App’, ‘Video’).	dimension
supply_type_ref_id	A unique reference identifier for the supply type.	dimension
total_conversions	This field represents the total number of conversion events recorded for advertising campaigns within the specified reporting period. Conversions can include various desired actions like purchases, sign-ups, or app installs.	metric
total_cost_dollars	The total advertising cost in US Dollars.	metric
total_cost_dollars_inc_serving_fees	The total advertising cost in US Dollars, including all serving fees.	metric
total_cost_insertion_order_currency	The total advertising cost in the native currency specified by the insertion order.	metric
total_cost_insertion_order_currency_inc_serving_fees	The total advertising cost in the native currency specified by the insertion order, including all serving fees.	metric
vcpm	The Viewable Cost Per Mille (thousand viewable impressions), calculated as total cost divided by the number of viewable impressions, multiplied by 1000.	metric
vendor_name	The name of the vendor or partner involved in the programmatic advertising transaction.	dimension
vendor_ref_id	A unique reference identifier for the vendor.	dimension
video_average_percentage_completed	The average percentage of a video ad that users watched before stopping or skipping.	metric
video_completion_rate	The percentage of video ads that were played to 100% completion.	metric
video_completions	The number of times a video advertisement was played entirely to its conclusion.	metric
video_cost_per_completion	The average cost incurred for each video ad completion.	metric
video_fill_rate	The percentage of video ad requests that were successfully filled with an ad.	metric
video_interaction_rate	The rate at which users interacted with a video ad (e.g., clicks, unmute, pause).	metric
video_preimpressions	The number of ad impressions served before the main video content or ad unit begins.	metric
video_quartile_25_count	The number of times a video advertisement was played for at least 25% of its total duration.	metric
video_quartile_50_count	The number of times a video advertisement was played for at least 50% of its total duration.	metric
video_quartile_75_count	The number of times a video advertisement was played for at least 75% of its total duration.	metric
video_revenue_per_completion	The average revenue generated for each video ad completion.	metric
video_start_rate	The percentage of video ads that began to play after being requested.	metric
video_starts	The number of times a video advertisement began playing.	metric
view_duration	The total duration in seconds that an ad creative was considered viewable by a user.	metric
viewability_rate	The percentage of ad impressions that met the industry standard for viewability (e.g., 50% of pixels in view for 1 second for display ads).	metric
viewable_impressions	The number of impressions that were deemed viewable according to established industry standards.	metric
vrpm	The Viewable Revenue Per Mille (thousand viewable impressions), calculated as total revenue divided by the number of viewable impressions, multiplied by 1000.	metric
week_of_year	The week number within the year (1-52 or 53) when the ad interaction or event occurred.	dimension
ymd	The date for which the programmatic advertising data is reported or aggregated. This field is used to define the reporting period for the collected data.	dimension
ymdh	A concatenated timestamp representing Year, Month, Day, and Hour, used for precise time-based reporting.	dimension