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

metric

ADVERTISER_FEE

ADVERTISER_FEE

metric

ADVERTISER_ID

ADVERTISER_ID

The unique identifier for the advertiser.

dimension

AD_SLOT_ID

AD_SLOT_ID

dimension

AGENCY_ID

AGENCY_ID

The unique identifier for the agency managing the campaign.

dimension

AUCTION_PRICE_SUM

AUCTION_PRICE_SUM

metric

AUDIBLE_ADS

AUDIBLE_ADS

metric

Advertiser

Advertiser

dimension

BANNER_ID

BANNER_ID

The unique identifier for the ad banner.

dimension

BIDS_COSTS

BIDS_COSTS

metric

BID_SUM

BID_SUM

metric

CAMPAIGN_ID

CAMPAIGN_ID

The unique identifier for the campaign.

dimension

CLICKS

CLICKS

The total number of clicks recorded for the ad.

metric

CONTACTS

CONTACTS

metric

CONTENTUNIT_ID

CONTENTUNIT_ID

dimension

COUNT

COUNT

A generic count metric, typically representing impressions or events.

metric

ClickRate

ClickRate

metric

DATE

DATE

The specific date for which the data is reported.

dimension

DAY

DAY

The specific day of the month for which the data is reported.

dimension

DEAL

DEAL

An identifier for a programmatic advertising deal, used to filter or select specific deals, particularly relevant for perspective reports like PROGRAMMATIC_TV.

dimension

Date

Date

The specific date for which the data is reported.

dimension

Deal

Deal

The identifier or name of the programmatic deal associated with the ad inventory.

dimension

EVENT_COMPLETE_COUNT

EVENT_COMPLETE_COUNT

The total number of times an ad event, such as a video ad playback, reached its completion.

metric

EVENT_IMPRESSION_COUNT

EVENT_IMPRESSION_COUNT

The total number of times an ad banner was displayed to a user.

metric

EVENT_START_COUNT

EVENT_START_COUNT

The total number of times an ad event, such as a video ad playback, was initiated.

metric

GROSS_ADS

GROSS_ADS

metric

IAS_COSTS

IAS_COSTS

metric

Impressions

Impressions

The total number of times an ad was displayed.

metric

MONTH

MONTH

The specific month for which the data is reported.

dimension

NETWORK_ID

NETWORK_ID

The unique identifier for the ad network.

dimension

NET_COST

NET_COST

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

metric

NET_DISPLAY_ADS

NET_DISPLAY_ADS

metric

NET_DISPLAY_ELIGIBLE_IMPRESSIONS

NET_DISPLAY_ELIGIBLE_IMPRESSIONS

metric

NET_DISPLAY_IAB_VIEWED_IMPRESSIONS

NET_DISPLAY_IAB_VIEWED_IMPRESSIONS

metric

NET_DISPLAY_MEASURED_IMPRESSIONS

NET_DISPLAY_MEASURED_IMPRESSIONS

metric

NET_VIDEO_ADS

NET_VIDEO_ADS

metric

NET_VIDEO_ELIGIBLE_IMPRESSIONS

NET_VIDEO_ELIGIBLE_IMPRESSIONS

metric

NET_VIDEO_IAB_VIEWED_IMPRESSIONS

NET_VIDEO_IAB_VIEWED_IMPRESSIONS

metric

NET_VIDEO_MEASURED_IMPRESSIONS

NET_VIDEO_MEASURED_IMPRESSIONS

metric

ORDER_ID

ORDER_ID

The unique identifier for the insertion order.

dimension

POSTVIEW_TURNOVER

POSTVIEW_TURNOVER

metric

REFERRER

REFERRER

dimension

SSP

SSP

dimension

SUPPLY_PARTNER_ID

SUPPLY_PARTNER_ID

An identifier for the supply-side partner (SSP) or ad network responsible for delivering ad impressions.

dimension

TAGGING_COSTS

TAGGING_COSTS

metric

TECH_FEE

TECH_FEE

metric

THIRD_PARTY_COSTS

THIRD_PARTY_COSTS

metric

TRAFFIC_TYPE

TRAFFIC_TYPE

dimension

TURNOVER

TURNOVER

metric

TURNOVER_CLICKS

TURNOVER_CLICKS

metric

TURNOVER_VIEWS

TURNOVER_VIEWS

metric

VIDEO_COMPLETE_IMPRESSIONS

VIDEO_COMPLETE_IMPRESSIONS

metric

WON_COUNT

WON_COUNT

metric

Win Rate

Win Rate

metric

YEAR

YEAR

The specific year for which the data is reported.

dimension

ad_format

ad_format

dimension

banner.active

banner.active

Indicates if the banner is currently active and eligible for serving.

dimension

banner.activeThirdPartyFeatures

banner.activeThirdPartyFeatures

A list of third-party features currently active for the banner.

dimension

banner.adSpotId

banner.adSpotId

dimension

banner.assetId

banner.assetId

A unique identifier for the creative asset (e.g., image, video file) associated with the banner.

metric

banner.assetUrl

banner.assetUrl

dimension

banner.bannerPoolId

banner.bannerPoolId

metric

banner.callToAction

banner.callToAction

dimension

banner.campaignId

banner.campaignId

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

metric

banner.childBannerIds

banner.childBannerIds

dimension

banner.clickTags

banner.clickTags

dimension

banner.clickUrl

banner.clickUrl

dimension

banner.combinedRuleId

banner.combinedRuleId

dimension

banner.compatibleSsps

banner.compatibleSsps

dimension

banner.creativeUrl

banner.creativeUrl

dimension

banner.deeplinkUrlEncode

banner.deeplinkUrlEncode

dimension

banner.deeplinkUrlParams

banner.deeplinkUrlParams

dimension

banner.deleted

banner.deleted

Indicates if the banner has been marked as deleted.

dimension

banner.description

banner.description

dimension

banner.duration

banner.duration

metric

banner.errorMessage

banner.errorMessage

dimension

banner.externalIconFiles

banner.externalIconFiles

dimension

banner.externalImageFiles

banner.externalImageFiles

dimension

banner.file

banner.file

Represents the creative asset file or its identifier associated with an advertising banner.

dimension

banner.filePaths

banner.filePaths

dimension

banner.filterIds

banner.filterIds

A collection of identifiers used to filter or categorize advertising banners for reporting or retrieval.

dimension

banner.iconFiles

banner.iconFiles

dimension

banner.id

banner.id

The unique identifier for the ad banner.

dimension

banner.imageFiles

banner.imageFiles

dimension

banner.indexFilePath

banner.indexFilePath

dimension

banner.infiniteRuntime

banner.infiniteRuntime

dimension

banner.landingPage

banner.landingPage

dimension

banner.lastUpdate

banner.lastUpdate

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

metric

banner.name

banner.name

The name of the banner.

dimension

banner.networkId

banner.networkId

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

metric

banner.params

banner.params

dimension

banner.parentBannerId

banner.parentBannerId

metric

banner.redirectTag

banner.redirectTag

dimension

banner.redirectUrl

banner.redirectUrl

dimension

banner.runtime

banner.runtime

dimension

banner.size

banner.size

Specifies the dimensions (e.g., width and height) of the advertising banner creative.

dimension

banner.sponsored

banner.sponsored

dimension

banner.ssl

banner.ssl

dimension

banner.status

banner.status

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

dimension

banner.statusMessages

banner.statusMessages

dimension

banner.tag

banner.tag

dimension

banner.tcfCompliant

banner.tcfCompliant

dimension

banner.tcfVendors

banner.tcfVendors

dimension

banner.templateId

banner.templateId

metric

banner.title

banner.title

dimension

banner.trackingUrl

banner.trackingUrl

dimension

banner.trackingUrls

banner.trackingUrls

dimension

banner.type

banner.type

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

dimension

banner.valid

banner.valid

dimension

banner.vastEvents

banner.vastEvents

Data related to specific events within a Video Ad Serving Template (VAST) video ad playback, such as start, pause, or complete.

dimension

banner.vastSettings

banner.vastSettings

Configuration settings specific to VAST (Video Ad Serving Template) video ads.

dimension

banner.vastTemplateId

banner.vastTemplateId

The identifier of the VAST (Video Ad Serving Template) template used for a video ad.

metric

banner.vastVersion

banner.vastVersion

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

dimension

banner.vastXml

banner.vastXml

The actual XML code of the VAST (Video Ad Serving Template) for a video ad.

dimension

banner.videoProperties

banner.videoProperties

Properties specific to video banners, such as duration, aspect ratio, or resolution.

dimension

banner.wrapperUrl

banner.wrapperUrl

dimension

campaign.active

campaign.active

Indicates if the campaign is currently active and running.

dimension

campaign.activeThirdPartyFeatures

campaign.activeThirdPartyFeatures

A list of third-party features currently active for the campaign.

dimension

campaign.bannerIds

campaign.bannerIds

A list of identifiers for banners associated with this campaign.

dimension

campaign.bidFactorIds

campaign.bidFactorIds

dimension

campaign.biddingStrategy

campaign.biddingStrategy

dimension

campaign.calculatedDailyBudget

campaign.calculatedDailyBudget

metric

campaign.calculatedDailyImpressions

campaign.calculatedDailyImpressions

The estimated or projected number of ad impressions to be delivered daily for a campaign.

metric

campaign.dailyBudget

campaign.dailyBudget

The maximum budget allocated for the campaign on a daily basis.

metric

campaign.dailyImpressions

campaign.dailyImpressions

metric

campaign.dailyPacing

campaign.dailyPacing

dimension

campaign.deals

campaign.deals

A list of programmatic deals associated with the campaign.

dimension

campaign.deleted

campaign.deleted

Indicates if the campaign has been marked as deleted.

dimension

campaign.deliveryTechnique

campaign.deliveryTechnique

dimension

campaign.filterIds

campaign.filterIds

dimension

campaign.id

campaign.id

The unique identifier for the campaign.

dimension

campaign.infiniteRuntime

campaign.infiniteRuntime

dimension

campaign.lastUpdate

campaign.lastUpdate

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

metric

campaign.maxCpc

campaign.maxCpc

metric

campaign.maxCpcv

campaign.maxCpcv

metric

campaign.maxCpm

campaign.maxCpm

metric

campaign.minVtr

campaign.minVtr

metric

campaign.name

campaign.name

The name of the campaign.

dimension

campaign.networkId

campaign.networkId

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

metric

campaign.optimization

campaign.optimization

dimension

campaign.orderId

campaign.orderId

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

metric

campaign.pace

campaign.pace

metric

campaign.runtimePacing

campaign.runtimePacing

dimension

campaign.runtimePacingFactor

campaign.runtimePacingFactor

metric

campaign.runtimes

campaign.runtimes

dimension

campaign.templateId

campaign.templateId

metric

campaign.thirdPartyCostIds

campaign.thirdPartyCostIds

dimension

campaign.totalBudget

campaign.totalBudget

The overall total budget allocated for the campaign’s entire duration.

metric

campaign.totalImpressions

campaign.totalImpressions

The cumulative total number of ad impressions delivered over the entire duration of a campaign.

metric

campaign.trackingPageIds

campaign.trackingPageIds

dimension

campaign.type

campaign.type

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

dimension

country

country

dimension

currency

currency

dimension

eCPC

eCPC

metric

eCPCV

eCPCV

metric

eCPV

eCPV

metric

fiscal_year

fiscal_year

dimension

media_category

media_category

dimension

media_channel

media_channel

dimension

media_type

media_type

dimension

network.accessibleFeatures

network.accessibleFeatures

dimension

network.adFarmId

network.adFarmId

metric

network.companyIds

network.companyIds

dimension

network.deleted

network.deleted

Indicates if the network has been marked as deleted.

dimension

network.hasHostingFee

network.hasHostingFee

dimension

network.id

network.id

The unique identifier for the ad network.

metric

network.isDmp

network.isDmp

dimension

network.isEnabledForRedirectCampaigns

network.isEnabledForRedirectCampaigns

dimension

network.lastUpdate

network.lastUpdate

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

metric

network.name

network.name

The name of the ad network.

dimension

network.somThirdPartyUplift

network.somThirdPartyUplift

metric

network.thirdPartyUplift

network.thirdPartyUplift

metric

order.activeThirdPartyFeatures

order.activeThirdPartyFeatures

A list of third-party features currently active for the order.

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

metric

order.calculatedDailyImpressions

order.calculatedDailyImpressions

The estimated or projected number of ad impressions to be delivered daily for an advertising order.

metric

order.campaignIds

order.campaignIds

A list of identifiers for campaigns associated with this order.

dimension

order.dailyBudget

order.dailyBudget

The maximum budget allocated for the order on a daily basis.

metric

order.dailyPacing

order.dailyPacing

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.

dimension

order.lastUpdate

order.lastUpdate

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

metric

order.name

order.name

The name of the order.

dimension

order.networkId

order.networkId

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

dimension

order.pace

order.pace

metric

order.runtimeBudgets

order.runtimeBudgets

dimension

order.runtimePacing

order.runtimePacing

dimension

order.runtimePacingFactor

order.runtimePacingFactor

metric

order.totalBudget

order.totalBudget

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

metric

order.totalImpressions

order.totalImpressions

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

metric

placement_id

placement_id

dimension

tactic

tactic

dimension

technology

technology

dimension

vendor

vendor

dimension