Active Agent: Most-used fields

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.

API name

Adverity UI name

Description

Use in Adverity

ADSQUARE_COSTS

ADSQUARE_COSTS

Costs associated with Adsquare services.

metric

ADVERTISER_FEE

ADVERTISER_FEE

Fee charged to the advertiser.

metric

ADVERTISER_ID

ADVERTISER_ID

Unique identifier for the advertiser.

dimension

AD_SLOT_ID

AD_SLOT_ID

Unique identifier for the ad slot where an advertisement is displayed.

dimension

AGENCY_ID

AGENCY_ID

Unique identifier for the agency managing the advertising campaign.

dimension

AUCTION_PRICE_SUM

AUCTION_PRICE_SUM

The sum of auction prices for ad impressions.

metric

BID_SUM

BID_SUM

The sum of bids made in ad auctions.

metric

CAMPAIGN_ID

CAMPAIGN_ID

Unique identifier for the campaign.

dimension

CLICKS

CLICKS

The total number of clicks on an advertisement.

metric

CONTACTS

CONTACTS

The total number of contacts or engagements with an advertisement.

metric

CONTENTUNIT_ID

CONTENTUNIT_ID

Unique identifier for a content unit where ads are placed.

dimension

COUNT

COUNT

A general count metric, often used for events or occurrences.

metric

DATE

DATE

The specific calendar date for reported data.

dimension

DAY

DAY

The day of the month as a numerical value.

metric

DEAL

DEAL

Information about the specific deal through which inventory was purchased.

metric

Date

Date

The specific calendar date for reported data.

dimension

EVENT_CLOSE_COUNT

EVENT_CLOSE_COUNT

The number of times a video ad was closed by the user.

metric

EVENT_COLLAPSE_COUNT

EVENT_COLLAPSE_COUNT

The number of times an expandable ad was collapsed by the user.

metric

EVENT_COMPLETE_COUNT

EVENT_COMPLETE_COUNT

The number of times a video ad played to 100% completion.

metric

EVENT_EXPAND_COUNT

EVENT_EXPAND_COUNT

The number of times an expandable ad was expanded by the user.

metric

EVENT_FIRST_QUARTILE_COUNT

EVENT_FIRST_QUARTILE_COUNT

The number of times a video ad played past the first 25% mark.

metric

EVENT_FULLSCREEN_COUNT

EVENT_FULLSCREEN_COUNT

The number of times a video ad was viewed in fullscreen mode.

metric

EVENT_IMPRESSION_COUNT

EVENT_IMPRESSION_COUNT

The number of times an ad was displayed and recorded as an impression.

metric

EVENT_MIDPOINT_COUNT

EVENT_MIDPOINT_COUNT

The number of times a video ad played past the 50% mark.

metric

EVENT_MUTE_COUNT

EVENT_MUTE_COUNT

The number of times a video ad was muted by the user.

metric

EVENT_PAUSE_COUNT

EVENT_PAUSE_COUNT

The number of times a video ad was paused by the user.

metric

EVENT_RESUME_COUNT

EVENT_RESUME_COUNT

The number of times a video ad was resumed by the user after being paused.

metric

EVENT_REWIND_COUNT

EVENT_REWIND_COUNT

The number of times a video ad was rewound by the user.

metric

EVENT_START_COUNT

EVENT_START_COUNT

The number of times a video ad started playing.

metric

EVENT_THIRD_QUARTILE_COUNT

EVENT_THIRD_QUARTILE_COUNT

The number of times a video ad played past the 75% mark.

metric

EVENT_UNMUTE_COUNT

EVENT_UNMUTE_COUNT

The number of times a video ad was unmuted by the user.

metric

HOUR

HOUR

Represents the hour of the day for data aggregation. Used for grouping report data by hour.

metric

IAS_COSTS

IAS_COSTS

The costs associated with Integral Ad Science (IAS) for ad verification and brand safety.

metric

MONTH

MONTH

The month of the year as a numerical value.

metric

NET_COST

NET_COST

The net cost of the advertising campaign, excluding certain fees or taxes.

metric

POSTVIEW_TURNOVER

POSTVIEW_TURNOVER

Turnover generated from users who saw an ad but did not click, converting within a defined post-view window.

metric

REFERRER

REFERRER

The URL of the page that referred the user to the ad.

dimension

SSP

SSP

The Supply-Side Platform (SSP) through which the ad impression was served.

dimension

SUPPLY_PARTNER_ID

SUPPLY_PARTNER_ID

Unique identifier for the supply partner providing the ad inventory.

dimension

TAGGING_COSTS

TAGGING_COSTS

Costs related to ad tagging or tracking implementation.

metric

TECH_FEE

TECH_FEE

Technical fees associated with ad delivery and platform usage.

metric

THIRD_PARTY_COSTS

THIRD_PARTY_COSTS

Costs incurred from third-party vendors or services.

metric

TRAFFIC_TYPE

TRAFFIC_TYPE

The type of traffic associated with the ad impression (e.g., desktop, mobile, video).

dimension

TURNOVER

TURNOVER

Total revenue or sales generated from advertising activities.

metric

TURNOVER_CLICKS

TURNOVER_CLICKS

Turnover specifically attributed to clicks on advertisements.

metric

TURNOVER_VIEWS

TURNOVER_VIEWS

Turnover attributed to views or impressions of advertisements.

metric

WON_COUNT

WON_COUNT

The number of ad auctions won.

metric

YEAR

YEAR

The year for which the data is reported.

metric

banner.active

banner.active

Indicates whether the banner is currently active.

dimension

banner.assetId

banner.assetId

Unique identifier for the creative asset used in the banner.

metric

banner.assetUrl

banner.assetUrl

The URL where the banner’s creative asset is hosted.

dimension

banner.bumperAdType

banner.bumperAdType

Specifies the type of bumper ad associated with the banner, if applicable.

dimension

banner.campaignId

banner.campaignId

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

metric

banner.childBannerIds

banner.childBannerIds

A list of IDs of child banners associated with this banner.

dimension

banner.clickTags

banner.clickTags

A list of click tags associated with the banner, used for tracking clicks.

dimension

banner.clickUrl

banner.clickUrl

The URL where the user is redirected after clicking the banner.

dimension

banner.creativeUrl

banner.creativeUrl

The URL where the banner’s creative content is hosted.

dimension

banner.deleted

banner.deleted

Indicates if the banner has been marked as deleted.

dimension

banner.description

banner.description

A descriptive text or brief summary provided for the banner creative.

dimension

banner.filePaths

banner.filePaths

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

dimension

banner.filterIds

banner.filterIds

A list of filter IDs applied to the banner.

dimension

banner.id

banner.id

The unique identifier for the banner.

metric

banner.indexFilePath

banner.indexFilePath

The file path to the main index file (e.g., HTML, Flash) of the banner creative.

dimension

banner.infiniteRuntime

banner.infiniteRuntime

Indicates if the banner has an infinite runtime, meaning no end date.

dimension

banner.landingPage

banner.landingPage

The landing page URL for the banner.

dimension

banner.lastUpdate

banner.lastUpdate

The timestamp of the last update to the banner configuration.

metric

banner.name

banner.name

The name of the banner.

dimension

banner.networkId

banner.networkId

The unique identifier of the network to which the banner belongs.

metric

banner.params

banner.params

Additional parameters or settings configured for the banner.

dimension

banner.parentBannerId

banner.parentBannerId

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

metric

banner.redirectTag

banner.redirectTag

A URL or tag used to redirect the user to a different location upon interaction with the banner.

dimension

banner.runtime

banner.runtime

The operational runtime period of the banner.

dimension

banner.size

banner.size

The dimensions of the banner creative (e.g., 300x250).

dimension

banner.sponsored

banner.sponsored

A flag indicating whether the banner placement is sponsored content.

dimension

banner.ssl

banner.ssl

Indicates if the banner is SSL compliant.

dimension

banner.status

banner.status

The current status of the banner (e.g., active, paused, archived).

dimension

banner.statusMessages

banner.statusMessages

Messages providing details about the banner’s status.

dimension

banner.templateId

banner.templateId

The unique identifier of the template used for the banner.

metric

banner.title

banner.title

The title or headline text displayed for the banner creative.

dimension

banner.type

banner.type

The type of the banner (e.g., image, video, rich media).

dimension

banner.valid

banner.valid

Indicates if the banner is considered valid for serving.

dimension

banner.vastEvents

banner.vastEvents

Events tracked for Video Ad Serving Template (VAST) enabled banners, such as impressions, clicks, or video playback progress.

dimension

banner.vastSettings

banner.vastSettings

Configuration settings for Video Ad Serving Template (VAST) enabled banners.

dimension

banner.vastTemplateId

banner.vastTemplateId

The identifier for the Video Ad Serving Template (VAST) used by the banner.

metric

banner.vastVersion

banner.vastVersion

The version of the Video Ad Serving Template (VAST) standard implemented for the banner.

dimension

banner.vastXml

banner.vastXml

The raw Video Ad Serving Template (VAST) XML content for the banner.

dimension

banner.videoProperties

banner.videoProperties

Properties specific to video content within the banner, such as duration, resolution, or autoplay settings.

dimension

banner.videoUrl

banner.videoUrl

The URL of the video creative used in the banner.

dimension

banner.wrapperUrl

banner.wrapperUrl

The URL for a VAST wrapper, pointing to an external VAST XML document that contains the actual ad creative or further wrappers.

dimension

banners

BANNER_ID

A general dimension representing the unique identifier for banners.

dimension

campaign.active

campaign.active

Indicates whether the campaign is currently active.

dimension

campaign.bannerIds

campaign.bannerIds

A list of IDs of banners associated with this campaign.

dimension

campaign.bidFactorIds

campaign.bidFactorIds

A list of bid factor IDs applied to the campaign.

dimension

campaign.biddingStrategy

campaign.biddingStrategy

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

dimension

campaign.calculatedDailyBudget

campaign.calculatedDailyBudget

The system-calculated daily budget for the campaign.

metric

campaign.calculatedDailyClicks

campaign.calculatedDailyClicks

The system-calculated daily number of clicks for the campaign.

metric

campaign.calculatedDailyImpressions

campaign.calculatedDailyImpressions

The system-calculated daily number of impressions for the campaign.

metric

campaign.dailyBudget

campaign.dailyBudget

The manually set daily budget for the campaign.

metric

campaign.dailyImpressions

campaign.dailyImpressions

The daily target or limit for impressions for the campaign.

metric

campaign.dailyPacing

campaign.dailyPacing

The daily pacing strategy for the campaign budget or impressions.

dimension

campaign.deals

campaign.deals

Information about deals associated with the campaign.

dimension

campaign.deleted

campaign.deleted

Indicates if the campaign has been marked as deleted.

dimension

campaign.deliveryTechnique

campaign.deliveryTechnique

The method used for delivering ads in the campaign.

dimension

campaign.filterIds

campaign.filterIds

A list of filter IDs applied to the campaign.

dimension

campaign.id

campaign.id

The unique identifier for the campaign.

metric

campaign.infiniteRuntime

campaign.infiniteRuntime

Indicates if the campaign has an infinite runtime, meaning no end date.

dimension

campaign.lastUpdate

campaign.lastUpdate

The timestamp of the last update to the campaign configuration.

metric

campaign.maxCpc

campaign.maxCpc

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

metric

campaign.maxCpcv

campaign.maxCpcv

The maximum Cost Per Completed View (CPCV) set for the campaign, specifically for video ads.

metric

campaign.maxCpm

campaign.maxCpm

The maximum Cost Per Mille (thousand impressions) set for the campaign.

metric

campaign.minVtr

campaign.minVtr

The minimum View-Through Rate (VTR) targeted for the campaign.

metric

campaign.name

campaign.name

The name of the campaign.

dimension

campaign.networkId

campaign.networkId

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

metric

campaign.optimization

campaign.optimization

The optimization strategy used for the campaign.

dimension

campaign.orderId

campaign.orderId

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

metric

campaign.pace

campaign.pace

The current pacing status or rate of the campaign.

metric

campaign.runtimePacing

campaign.runtimePacing

The pacing strategy applied over the entire runtime of the campaign.

dimension

campaign.runtimePacingFactor

campaign.runtimePacingFactor

A factor used to adjust the runtime pacing of the campaign.

metric

campaign.runtimes

campaign.runtimes

The defined runtime periods for the campaign.

dimension

campaign.templateId

campaign.templateId

The unique identifier of the template used for the campaign.

metric

campaign.thirdPartyCostIds

campaign.thirdPartyCostIds

A list of third-party cost IDs associated with the campaign.

dimension

campaign.totalBudget

campaign.totalBudget

The total budget allocated for the entire campaign.

metric

campaign.totalClicks

campaign.totalClicks

The total number of clicks recorded for the entire campaign.

metric

campaign.totalImpressions

campaign.totalImpressions

The total number of impressions delivered for the entire campaign.

metric

campaign.trackingPageIds

campaign.trackingPageIds

A list of tracking page IDs used in the campaign.

dimension

campaign.type

campaign.type

The type of the campaign (e.g., brand, performance).

dimension

campaigns

CAMPAIGN_ID

A general dimension representing the unique identifier for campaigns.

dimension

network.accessibleFeatures

network.accessibleFeatures

A list of features accessible within the network.

dimension

network.adFarmId

network.adFarmId

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

metric

network.companyIds

network.companyIds

A list of company IDs associated with the network.

dimension

network.deleted

network.deleted

Indicates if the network has been marked as deleted.

dimension

network.hasHostingFee

network.hasHostingFee

Indicates if the network incurs a hosting fee.

dimension

network.id

network.id

The unique identifier for the network.

metric

network.isDmp

network.isDmp

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

dimension

network.isEnabledForRedirectCampaigns

network.isEnabledForRedirectCampaigns

Indicates if the network is enabled to run redirect campaigns.

dimension

network.lastUpdate

network.lastUpdate

The timestamp of the last update to the network configuration.

metric

network.name

network.name

The name of the network.

dimension

network.somThirdPartyUplift

network.somThirdPartyUplift

The third-party uplift percentage or value for the network.

metric

networks

NETWORK_ID

A general dimension representing the unique identifier for networks.

dimension

order.advertiserId

order.advertiserId

The unique identifier of the advertiser associated with the order.

metric

order.agencyId

order.agencyId

The unique identifier of the agency associated with the order.

metric

order.calculatedDailyBudget

order.calculatedDailyBudget

The system-calculated daily budget for the order.

metric

order.calculatedDailyClicks

order.calculatedDailyClicks

The system-calculated daily number of clicks for the order.

metric

order.calculatedDailyImpressions

order.calculatedDailyImpressions

The system-calculated daily number of impressions for the order.

metric

order.campaignIds

order.campaignIds

A list of IDs of campaigns associated with this order.

dimension

order.dailyBudget

order.dailyBudget

The manually set daily budget for the order.

metric

order.dailyPacing

order.dailyPacing

The daily pacing strategy for the order budget.

dimension

order.deleted

order.deleted

Indicates if the order has been marked as deleted.

dimension

order.id

order.id

The unique identifier for the order.

metric

order.lastUpdate

order.lastUpdate

The timestamp of the last update to the order configuration.

metric

order.name

order.name

The name of the order.

dimension

order.networkId

order.networkId

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

metric

order.pace

order.pace

The current pacing status or rate of the order.

metric

order.runtimeBudgets

order.runtimeBudgets

The budget allocations over the runtime periods of the order.

dimension

order.runtimePacing

order.runtimePacing

The pacing strategy applied over the entire runtime of the order.

dimension

order.runtimePacingFactor

order.runtimePacingFactor

A factor used to adjust the runtime pacing of the order.

metric

order.totalBudget

order.totalBudget

The total budget allocated for the entire order.

metric

order.totalClicks

order.totalClicks

The total number of clicks recorded for the entire order.

metric

order.totalImpressions

order.totalImpressions

The total number of impressions delivered for the entire order.

metric

orders

ORDER_ID

A general dimension representing the unique identifier for orders.

dimension