Skip to content
Book a demo

Connect documentation

All documentation
Documentation

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.

FieldAdverity UI nameType
actionDimension

Represents a specific user interaction or event associated with an ad, such as a click, conversion, or engagement.

app_bundleDimension

The unique identifier or bundle ID of the mobile application where an ad was displayed.

attribution_modeDimension

The method used to assign credit for a conversion or other event to a particular ad touchpoint.

billing_period_nameDimension

The name or identifier of the billing period associated with the reported data, used for financial reconciliation and reporting within the programmatic advertising platform.

billing_period_ref_idDimension

A unique reference ID for the billing period, providing a distinct identifier for financial transactions and reporting cycles.

brand_nameDimension

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.

brand_ref_idDimension

A unique identifier for the brand associated with the advertising campaign.

browser_nameDimension

The name of the web browser used by the user when viewing the advertisement.

cityDimension

The city from which the ad impression or event originated, used for geographic targeting and reporting.

clicksMetric

The total number of times users interacted with and clicked on the advertisement.

connection_type_nameDimension

The name of the user's internet connection type (e.g., Wi-Fi, 4G, DSL) at the time of the ad interaction.

connection_type_ref_idDimension

A unique reference identifier for the internet connection type.

conversion_priorityDimension

The priority level assigned to a specific conversion event, often used in optimization strategies.

countryDimension

The country from which the ad impression or event originated, used for geographic targeting and reporting.

country_subdivisionDimension

A geographic subdivision within a country, such as a state, province, or region.

creative_dimensionsDimension

The pixel dimensions (e.g., 300x250) of the ad creative displayed.

creative_heightDimension

The height of the creative asset in pixels.

creative_nameDimension

The name of the creative asset used in the advertisement.

creative_ref_idDimension

A unique identifier for the creative asset used in the advertisement.

creative_widthDimension

The width of the creative asset in pixels.

cross_deviceDimension

Indicates whether a user's journey or conversion involved interactions across multiple devices.

ctrMetric

The Click-Through Rate, calculated as the number of clicks divided by the number of impressions, expressed as a percentage.

currency_codeDimension

The ISO 4217 code for the currency used in financial transactions (e.g., 'USD' for United States Dollar).

currency_nameDimension

The full name of the currency used for financial reporting.

currency_ref_idDimension

A unique reference identifier for the currency.

currency_symbolDimension

The symbol representing the currency (e.g., '$', '€').

cv_rateMetric

The Conversion Rate, calculated as the number of conversions divided by the number of impressions or clicks, expressed as a percentage.

day_of_weekDimension

The day of the week (e.g., Monday, Tuesday) when the ad interaction or event occurred.

device_type_nameDimension

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.

device_type_ref_idDimension

A unique reference identifier for the type of device used (e.g., mobile, desktop, tablet).

domainDimension

The internet domain associated with an ad impression, such as the publisher's domain or the referring domain.

ecpaMetric

The Effective Cost Per Action (or Acquisition), calculated as the total cost divided by the number of conversions.

ecpcMetric

The Effective Cost Per Click, calculated as the total cost divided by the number of clicks.

ecpmMetric

The Effective Cost Per Mille (thousand impressions), calculated as the total cost divided by the number of impressions, multiplied by 1000.

erpaMetric

The Effective Revenue Per Action, calculated as the total revenue generated divided by the number of actions or conversions.

erpcMetric

The Effective Revenue Per Click, calculated as the total revenue generated divided by the number of clicks.

erpmMetric

The Effective Revenue Per Mille (thousand impressions), calculated as the total revenue generated divided by the number of impressions, multiplied by 1000.

eventsMetric

The total count of specified events that occurred within the reporting period.

feeMetric

The amount charged or incurred as a fee for programmatic advertising activities, contributing to overall ad spend.

fee_currency_nameDimension

The name of the currency in which the fee is denominated (e.g., 'US Dollar', 'Euro').

fee_currency_symbolDimension

The symbol representing the currency of the fee (e.g., '$', '€').

fee_ecpmMetric

The effective cost per thousand impressions (eCPM) for the specific fee, calculated to understand the cost efficiency relative to ad views.

fee_usdMetric

The fee amount converted and reported in United States Dollars (USD) for standardized financial analysis.

fee_usd_ecpmMetric

The effective cost per thousand impressions (eCPM) for the fee, converted and reported in United States Dollars (USD).

feesMetric

An aggregation or collection of various fees associated with the programmatic advertising campaigns and platform usage.

hour_of_dayDimension

The hour of the day (0-23) when the ad interaction or event occurred, used for granular time-based reporting.

hour_of_weekDimension

The hour within the week (0-167) when the ad interaction or event occurred.

impression_typeDimension

The specific type of ad impression (e.g., display, video, native).

impressionsMetric

The total number of times an advertisement was displayed to users.

insertion_order_nameDimension

The name of the insertion order, which is a contractual agreement that outlines the terms of an advertising campaign.

insertion_order_ref_idDimension

A unique identifier for the insertion order.

inventory_ref_idDimension

A unique reference identifier for the ad inventory where the ad was displayed.

inventory_source_nameDimension

The name of the source or publisher providing the ad inventory.

inventory_source_ref_idDimension

A unique reference identifier for the inventory source.

language_nameDimension

The name of the language associated with the user or the content where the ad was served.

language_ref_idDimension

A unique reference identifier for the language.

measurable_impressionsMetric

The number of impressions that were measurable for viewability according to industry standards.

monthDimension

The month of the year when the ad interaction or event occurred.

month_of_yearDimension

The numerical representation of the month within the year (1-12).

operating_system_nameDimension

The name of the operating system (e.g., iOS, Android, Windows) of the device on which the ad was displayed.

operating_system_ref_idDimension

A unique reference identifier for the operating system.

order_revenueMetric

The total revenue generated from orders attributed to advertising efforts.

page_domainDimension

The internet domain of the webpage where the ad was displayed.

page_position_nameDimension

The descriptive name of the ad's position on a webpage (e.g., 'Above the Fold', 'Sidebar').

page_position_ref_idDimension

A unique reference identifier for the ad's position on a page.

post_click_conversionsMetric

The number of conversions attributed to a user clicking on an advertisement.

post_click_cv_rateMetric

The post-click conversion rate, measuring the percentage of users who convert after clicking on an ad.

post_codeDimension

The postal code associated with the user's location, used for geographic targeting and reporting.

post_view_conversionsMetric

The number of conversions attributed to a user viewing an advertisement without clicking it.

post_view_cv_rateMetric

The post-view conversion rate, measuring the percentage of users who convert after seeing an ad but not clicking on it.

post_viewable_conversionsMetric

The number of conversions attributed to viewable ad impressions.

post_viewable_cv_rateMetric

The post-viewable conversion rate, measuring the percentage of users who convert after a viewable ad impression.

referer_domainDimension

The domain of the webpage that referred the user to the page where the ad was displayed.

request_domainDimension

The internet domain from which the ad request originated.

revenueMetric

The total gross revenue generated from advertising activities.

serving_feesMetric

Fees specifically incurred for the delivery or serving of advertisements.

source_device_type_nameDimension

The name of the device type (e.g., 'Mobile', 'Desktop', 'Tablet') from which the ad request originated.

source_device_type_ref_idDimension

A unique reference identifier for the source device type.

supply_type_nameDimension

The name of the supply channel or inventory type (e.g., 'Web', 'In-App', 'Video').

supply_type_ref_idDimension

A unique reference identifier for the supply type.

total_conversionsMetric

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.

total_cost_dollarsMetric

The total advertising cost in US Dollars.

total_cost_dollars_inc_serving_feesMetric

The total advertising cost in US Dollars, including all serving fees.

total_cost_insertion_order_currencyMetric

The total advertising cost in the native currency specified by the insertion order.

total_cost_insertion_order_currency_inc_serving_feesMetric

The total advertising cost in the native currency specified by the insertion order, including all serving fees.

vcpmMetric

The Viewable Cost Per Mille (thousand viewable impressions), calculated as total cost divided by the number of viewable impressions, multiplied by 1000.

video_average_percentage_completedMetric

The average percentage of a video ad that users watched before stopping or skipping.

video_completion_rateMetric

The percentage of video ads that were played to 100% completion.

video_completionsMetric

The number of times a video advertisement was played entirely to its conclusion.

video_cost_per_completionMetric

The average cost incurred for each video ad completion.

video_fill_rateMetric

The percentage of video ad requests that were successfully filled with an ad.

video_interaction_rateMetric

The rate at which users interacted with a video ad (e.g., clicks, unmute, pause).

video_preimpressionsMetric

Counts the number of times a video advertisement was loaded or prepared to be displayed, prior to being counted as a standard video impression.

video_quartile_25_countMetric

The number of times a video advertisement was played for at least 25% of its total duration.

video_quartile_50_countMetric

The number of times a video advertisement was played for at least 50% of its total duration.

video_quartile_75_countMetric

The number of times a video advertisement was played for at least 75% of its total duration.

video_revenue_per_completionMetric

The average revenue generated for each video ad completion.

video_start_rateMetric

The percentage of video ads that began to play after being requested.

video_startsMetric

The number of times a video advertisement began playing.

view_durationMetric

The total duration in seconds that an ad creative was considered viewable by a user.

viewability_rateMetric

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).

viewable_impressionsMetric

The number of impressions that were deemed viewable according to established industry standards.

vrpmMetric

The Viewable Revenue Per Mille (thousand viewable impressions), calculated as total revenue divided by the number of viewable impressions, multiplied by 1000.

week_of_yearDimension

The week number within the year (1-52 or 53) when the ad interaction or event occurred.

ymdDimension

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.

ymdhDimension

A concatenated timestamp representing Year, Month, Day, and Hour, used for precise time-based reporting.