Skip to content
Book a demo

Connect documentation

All documentation
Documentation

Active Agent: Most-used fields

The table below gives information about most-used fields that you can import from Active Agent. 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
ADVERTISER_FEEMetric

The fee charged to the advertiser for running campaigns.

ADVERTISER_IDDimension

The unique identifier for the advertiser.

AGENCY_IDDimension

The unique identifier for the advertising agency managing the campaigns.

AUCTION_PRICE_SUMMetric

The sum of the prices paid in ad auctions for delivered impressions or clicks.

AUDIBLE_ADSMetric

The number of audible ad impressions. This is a metric related to ad performance.

AdvertiserDimension

The name of the advertiser associated with the campaign or ad creative.

BANNER_IDDimension

The unique identifier for the ad banner.

BIDS_COSTSMetric

The costs associated with bids placed for ad impressions.

CAMPAIGN_IDDimension

The unique identifier for a specific advertising campaign.

CLICKSMetric

The total number of clicks recorded for an ad or campaign.

CONTACTSMetric

The number of unique users reached or exposed to an ad.

CONTEXTUAL_COSTSMetric

Costs associated with contextual targeting, which places ads on websites or apps with content related to the ad.

ClickRateMetric

The ratio of clicks to impressions, often expressed as a percentage (Click-Through Rate or CTR).

DATEDimension

The specific date for which the reported data is aggregated.

DEALDimension

The unique identifier for a private marketplace (PMP) deal or guaranteed deal.

DateDimension

The specific date for which the data is reported.

DealDimension

The name or description of the private marketplace (PMP) deal or guaranteed deal.

EVENT_COMPLETE_COUNTMetric

The count of instances where a defined event (e.g., video completion) was fully completed.

EVENT_IMPRESSION_COUNTMetric

The count of impressions recorded for a specific event type.

EVENT_START_COUNTMetric

The count of instances where a defined event (e.g., video playback) was initiated.

GROSS_ADSMetric

The total number of gross ad impressions.

ImpressionsMetric

The total number of times an ad was displayed.

NETWORK_IDDimension

The unique identifier for the advertising network where the campaign is running.

NET_COSTMetric

The net cost of the ad campaign after any deductions or fees.

NET_DISPLAY_ADSMetric

The net number of display ad impressions served after any adjustments.

NET_DISPLAY_ELIGIBLE_IMPRESSIONSMetric

The number of display ad impressions that were eligible to be viewed.

NET_DISPLAY_IAB_VIEWED_IMPRESSIONSMetric

This field provides the net count of display ad impressions that met the Interactive Advertising Bureau (IAB) viewability standards.

NET_DISPLAY_MEASURED_IMPRESSIONSMetric

The number of display ad impressions that were successfully measured.

NET_VIDEO_ADSMetric

The net number of video ad impressions served after any adjustments.

NET_VIDEO_ELIGIBLE_IMPRESSIONSMetric

The number of video ad impressions that were eligible to be viewed.

NET_VIDEO_IAB_VIEWED_IMPRESSIONSMetric

This field provides the net count of video ad impressions that met the Interactive Advertising Bureau (IAB) viewability standards.

NET_VIDEO_MEASURED_IMPRESSIONSMetric

The number of video ad impressions that were successfully measured.

ORDER_IDDimension

The unique identifier for the insertion order.

POSTCLICK_CONVERSIONSMetric

The number of conversions that occurred after a user clicked on an ad.

POSTCLICK_REVENUEMetric

Revenue generated from conversions that occurred after a user clicked on an ad.

POSTVIEW_CONVERSIONSMetric

The number of conversions that occurred after a user viewed an ad, without necessarily clicking it.

POSTVIEW_REVENUEMetric

Revenue generated from conversions that occurred after a user viewed an ad, without necessarily clicking it.

PREBID_COSTSMetric

Costs incurred during the pre-bid phase of programmatic advertising, before the actual ad auction.

SSPDimension

The Supply-Side Platform (SSP) through which ad inventory is procured.

SUPPLY_PARTNER_IDDimension

The unique identifier for the supply partner providing the ad inventory.

TECH_FEEMetric

Fees charged by technology providers in the ad tech ecosystem.

THIRD_PARTY_COSTSMetric

Costs associated with third-party vendors or services, such as measurement or data providers.

VIDEO_COMPLETE_IMPRESSIONSMetric

The number of video ad impressions that played to 100% completion.

Win RateMetric

The percentage of bid requests won by the DSP in ad auctions.

ad_formatDimension

The format of the ad, e.g., banner, video, native.

banner.activeDimension

Indicates whether the banner ad is currently active and eligible for delivery.

banner.activeThirdPartyFeaturesDimension

A list of active third-party features enabled for the banner ad, such as specific tracking or verification services.

banner.adSpotIdDimension

Identifier for the specific ad spot where a banner is displayed.

banner.assetIdMetric

The unique identifier for the creative asset associated with the banner ad.

banner.assetUrlDimension

The URL where the creative asset for the banner ad is hosted.

banner.bannerPoolIdMetric

Identifier for a group or pool of banners.

banner.callToActionDimension

The call-to-action text displayed on the banner ad (e.g., 'Learn More', 'Shop Now').

banner.campaignIdMetric

The unique identifier of the campaign to which the banner ad belongs.

banner.childBannerIdsDimension

A list of unique identifiers for child banner ads associated with this parent banner (e.g., for ad variations).

banner.clickTagsDimension

A list of click tags used for tracking clicks and redirecting users for the banner ad.

banner.clickUrlDimension

The URL to which the user is redirected upon clicking the banner ad.

banner.combinedRuleIdDimension

Unique identifier for the combined rule applied to a specific banner within an advertising campaign. This field helps in tracking which set of targeting or bidding rules are associated with a banner.

banner.compatibleSspsDimension

A list of Supply-Side Platforms (SSPs) that are compatible with the banner ad creative.

banner.creativeUrlDimension

The URL where the banner ad creative is hosted.

banner.deeplinkUrlEncodeDimension

Indicates whether the deeplink URL for the banner ad should be URL-encoded.

banner.deeplinkUrlParamsDimension

Parameters to be appended to the deeplink URL for the banner ad.

banner.deletedDimension

Indicates whether the banner ad has been soft-deleted.

banner.descriptionDimension

A descriptive text for the banner ad.

banner.durationMetric

The duration of the banner ad, particularly relevant for video or animated formats.

banner.errorMessageDimension

Any error message associated with the banner, indicating issues during ad serving, creative approval, or other operational processes. This helps in troubleshooting and optimizing banner performance.

banner.externalIconFilesDimension

A list of URLs or identifiers for external icon files used in the banner ad.

banner.externalImageFilesDimension

A list of URLs or identifiers for external image files used in the banner ad.

banner.fileDimension

The file name or path of the primary creative file for the banner ad.

banner.filePathsDimension

A list of file paths for assets used in the banner ad.

banner.filterIdsDimension

A list of unique identifiers for filters applied to the banner ad.

banner.iconFilesDimension

A list of URLs or identifiers for icon files used in the banner ad.

banner.idDimension

The unique identifier for the banner ad creative.

banner.imageFilesDimension

A list of URLs or identifiers for image files used in the banner ad.

banner.indexFilePathDimension

The file path to the main index file for complex HTML5 banner creatives.

banner.infiniteRuntimeDimension

Indicates whether the banner ad is configured to run indefinitely without an end date.

banner.landingPageDimension

The URL of the landing page where users are directed after clicking the banner ad.

banner.lastUpdateMetric

The timestamp of the last update made to the banner ad configuration.

banner.nameDimension

The name of the banner ad creative.

banner.networkIdMetric

The unique identifier for the network associated with the banner ad.

banner.paramsDimension

This field contains various parameters or attributes associated with a specific advertising banner, providing detailed information and configuration beyond basic identification.

banner.parentBannerIdMetric

The unique identifier of the parent banner ad if this is a child banner.

banner.postHtmlCodeDimension

HTML code to be inserted after the main banner ad creative, often used for tracking or additional content.

banner.preHtmlCodeDimension

HTML code to be inserted before the main banner ad creative, often used for custom styling or scripts.

banner.redirectTagDimension

A redirect tag used for serving the banner ad, often from a third-party ad server.

banner.redirectUrlDimension

The URL used for redirecting to the actual banner ad creative or landing page.

banner.runtimeDimension

The configured runtime period or schedule for the banner ad.

banner.shopIdDimension

The unique identifier of the shop or advertiser associated with a specific advertising banner. This ID helps in categorizing and reporting banner performance for individual client entities.

banner.sizeDimension

The dimensions (width x height) of the banner ad.

banner.sponsoredDimension

Indicates whether the banner is part of a sponsored campaign or a sponsored content placement. This is a boolean flag (true/false) used for identifying sponsored inventory.

banner.sslDimension

Indicates whether the banner ad is SSL-compliant (served over HTTPS).

banner.statusDimension

The current status of the banner ad (e.g., active, paused, pending review).

banner.statusMessagesDimension

A list of messages providing details about the current status of the banner ad.

banner.tagDimension

The ad tag or creative tag associated with the banner ad.

banner.tcfCompliantDimension

Indicates whether the banner ad is compliant with the Transparency & Consent Framework (TCF) for privacy regulations.

banner.tcfVendorsDimension

A list of vendors associated with the banner ad that are compliant with the Transparency & Consent Framework (TCF).

banner.templateIdMetric

The unique identifier of the template used to create the banner ad.

banner.titleDimension

The title of the banner ad creative.

banner.trackingUrlDimension

The primary URL used for tracking impressions or clicks for the banner ad.

banner.trackingUrlsDimension

A list of URLs used for tracking impressions, clicks, or other interactions with the banner ad.

banner.typeDimension

The type of banner ad, such as image, HTML5, or video.

banner.validDimension

Indicates whether the banner ad is considered valid and properly configured for delivery.

banner.vastEventsDimension

A list of VAST (Video Ad Serving Template) events configured for video banner ads.

banner.vastSettingsDimension

Settings specific to VAST (Video Ad Serving Template) for video banner ads.

banner.vastTemplateIdMetric

The unique identifier of the VAST (Video Ad Serving Template) template used for video banner ads.

banner.vastVersionDimension

The version of the VAST (Video Ad Serving Template) specification used for video banner ads.

banner.vastXmlDimension

The XML content of the VAST (Video Ad Serving Template) for video banner ads.

banner.videoPropertiesDimension

Properties specific to video banner ads, such as aspect ratio or autoplay settings.

banner.wrapperUrlDimension

The URL for a VAST wrapper tag, which can chain multiple video ad responses.

campaign.activeDimension

Indicates whether the campaign is currently active and delivering ads.

campaign.activeThirdPartyFeaturesDimension

A list of active third-party features enabled for the campaign, such as specific tracking or verification services.

campaign.bannerIdsDimension

A list of unique identifiers for banner ads associated with the campaign.

campaign.bidFactorIdsDimension

A list of unique identifiers for bid factors applied to the campaign, influencing bidding strategy.

campaign.biddingStrategyDimension

The bidding strategy configured for the campaign (e.g., maximize clicks, target CPA).

campaign.calculatedDailyBudgetMetric

The calculated daily budget for the campaign, taking into account pacing and overall budget.

campaign.calculatedDailyImpressionsMetric

The calculated number of daily impressions for the campaign, considering pacing and total impressions.

campaign.cpxMetricsDimension

Metrics related to Cost Per X (CPX) goals, where X can be action, install, lead, etc., for a campaign.

campaign.dailyBudgetMetric

The maximum amount of money the campaign is allowed to spend per day.

campaign.dailyImpressionsMetric

The target or actual number of impressions delivered per day for the campaign.

campaign.dailyPacingDimension

The daily pacing setting for the campaign, controlling how the budget is spent throughout the day.

campaign.dealsDimension

A list of deals (e.g., PMP deals) associated with the campaign.

campaign.deletedDimension

Indicates whether the campaign has been soft-deleted.

campaign.deliveryTechniqueDimension

The delivery technique used for the campaign (e.g., standard, accelerated).

campaign.dsaBehalfDimension

Indicates if the campaign is running on behalf of another entity under the Digital Services Act (DSA).

campaign.dsaPaidDimension

Indicates if the campaign is paid for by another entity under the Digital Services Act (DSA).

campaign.filterIdsDimension

A list of unique identifiers for filters applied to the campaign.

campaign.idDimension

The unique identifier for the campaign.

campaign.infiniteRuntimeDimension

Indicates whether the campaign is configured to run indefinitely without an end date.

campaign.lastUpdateMetric

The timestamp of the last update made to the campaign configuration.

campaign.maxCpcMetric

The maximum Cost Per Click (CPC) bid allowed for the campaign.

campaign.maxCpcvMetric

The maximum Cost Per Completed View (CPCV) bid allowed for video campaigns.

campaign.maxCpmMetric

The maximum Cost Per Mille (CPM) bid allowed for the campaign.

campaign.minVtrMetric

The minimum Video Through Rate (VTR) required for video campaigns, representing the percentage of videos watched to completion.

campaign.nameDimension

The name of the campaign.

campaign.networkIdMetric

The unique identifier for the network associated with the campaign.

campaign.optimizationDimension

Settings related to the optimization goals and methods for the campaign.

campaign.orderIdMetric

The unique identifier of the order to which the campaign belongs.

campaign.paceMetric

The pacing strategy for the campaign, controlling the rate of budget spending.

campaign.runtimePacingDimension

Indicates if runtime pacing is enabled for the campaign to distribute spending over its flight duration.

campaign.runtimePacingFactorMetric

The factor used in runtime pacing to adjust the spending rate for the campaign.

campaign.runtimesDimension

A list of runtime periods or schedules configured for the campaign.

campaign.templateIdMetric

The unique identifier of the template used to create the campaign.

campaign.thirdPartyCostIdsDimension

A list of unique identifiers for third-party costs associated with the campaign.

campaign.totalBudgetMetric

The total budget allocated for the entire duration of the campaign.

campaign.totalImpressionsMetric

The total number of impressions planned or delivered for the entire campaign duration.

campaign.trackingPageIdsDimension

A list of unique identifiers for tracking pages associated with the campaign, used for conversion tracking.

campaign.typeDimension

The type of campaign (e.g., branding, performance, video).

countryDimension

The country targeted by the campaign or where the ad impression occurred.

currencyDimension

The currency used for reporting financial metrics.

eCPCMetric

Effective Cost Per Click, calculated by dividing total cost by total clicks.

eCPCVMetric

Effective Cost Per Completed View, calculated by dividing total cost by total completed video views.

eCPVMetric

Effective Cost Per View, calculated by dividing total cost by total video views.

fiscal_yearDimension

This field represents the fiscal year to which the collected data belongs, enabling financial reporting and analysis aligned with a fiscal calendar.

media_categoryDimension

The category of media where the ad was displayed (e.g., social, display, video).

media_channelDimension

The channel of media where the ad was displayed (e.g., web, mobile app).

media_typeDimension

The type of media used for the ad creative (e.g., image, video, rich media).

network.accessibleFeaturesDimension

A list of features accessible within the network.

network.adFarmIdMetric

Identifier for an ad farm within the ad network where ads are served.

network.companyIdsDimension

A list of company identifiers associated with the network.

network.deletedDimension

Indicates whether the network has been soft-deleted.

network.hasHostingFeeDimension

Indicates whether the network incurs a hosting fee.

network.idMetric

The unique identifier for the network.

network.isDmpDimension

Indicates whether the network functions as a Data Management Platform (DMP).

network.isEnabledForRedirectCampaignsDimension

Indicates whether the network is enabled to support redirect campaigns.

network.lastUpdateMetric

The timestamp of the last update made to the network configuration.

network.nameDimension

The name of the network.

network.somThirdPartyUpliftMetric

A metric representing the additional performance or value generated by a third-party integration within a specific ad network, potentially indicating a share of market uplift or similar value.

network.thirdPartyUpliftMetric

The third-party uplift percentage applied within the network, often related to data or verification costs.

order.activeThirdPartyFeaturesDimension
order.advertiserIdMetric

The unique identifier of the advertiser associated with the order.

order.agencyIdMetric

The unique identifier of the agency associated with the order.

order.calculatedDailyBudgetMetric

The daily budget calculated for the order based on its total budget and runtime.

order.calculatedDailyClicksMetric

The number of clicks recorded for an advertising order on a daily basis, as calculated by the Active Agent platform.

order.calculatedDailyImpressionsMetric

The calculated number of daily impressions for the order, considering pacing and total impressions.

order.campaignIdsDimension

A list of identifiers for campaigns associated with this order.

order.dailyBudgetMetric

The maximum amount of money the order is allowed to spend per day.

order.dailyPacingDimension

The daily pacing setting for the order, controlling the rate at which the daily budget is spent throughout the day.

order.deletedDimension

Indicates if the order has been marked as deleted.

order.dsaBehalfDimension

Indicates if the order is running on behalf of another entity under the Digital Services Act (DSA).

order.dsaPaidDimension

Indicates if the order is paid for by another entity under the Digital Services Act (DSA).

order.idDimension

The unique identifier for the order.

order.lastUpdateMetric

The timestamp of the last update made to the order configuration.

order.nameDimension

The name of the order.

order.networkIdDimension

The unique identifier of the ad network associated with the order.

order.paceMetric

The pacing strategy or setting that controls the speed at which the order's budget is spent.

order.runtimeBudgetsDimension

The budget allocations and limits defined for different runtime periods or phases of the advertising order.

order.runtimePacingDimension

The runtime pacing setting for the order, which distributes the budget evenly across the order's entire duration.

order.runtimePacingFactorMetric

The factor used in runtime pacing to adjust the spending rate for the order.

order.totalBudgetMetric

The overall total budget allocated for the order's entire duration.

order.totalClicksMetric

The aggregate sum of all clicks recorded for an advertising order over its entire duration or within the specified reporting period.

order.totalImpressionsMetric

The cumulative total number of ad impressions delivered over the entire duration of an advertising order.

placement_idDimension

The unique identifier for the ad placement where the ad is displayed.

tacticDimension

This field identifies the specific advertising tactic or strategy employed for the reported data, allowing for granular analysis of campaign performance by different approaches.

vendorDimension

The vendor associated with the ad impression or creative (e.g., ad server, data provider).