Outbrain: Most-used fields

Outbrain: Most-used fields#

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

Add to Cart.averageValue

Add to Cart.averageValue

The average monetary value reported for conversions from clicks for the ‘Add to Cart’ conversion event.

metric

Add to Cart.conversionRate

Add to Cart.conversionRate

The average percentage rate of conversions from clicks per click for the ‘Add to Cart’ conversion event.

metric

Add to Cart.conversions

Add to Cart.conversions

The total number of conversions attributed to clicks for the ‘Add to Cart’ conversion event.

metric

Add to Cart.cpa

Add to Cart.cpa

The average Cost Per Acquisition (CPA) for conversions attributed to clicks for the ‘Add to Cart’ conversion event.

metric

Add to Cart.roas

Add to Cart.roas

The Return On Ad Spend (ROAS), calculated as the total conversion value attributed to clicks divided by the spend for the ‘Add to Cart’ conversion event.

metric

Add to Cart.sumValue

Add to Cart.sumValue

The total monetary value reported for conversions from clicks for the ‘Add to Cart’ conversion event.

metric

Add to Cart.totalAverageValue

Add to Cart.totalAverageValue

The average monetary value reported for all conversions (clicks or views) for the ‘Add to Cart’ conversion event.

metric

Add to Cart.totalConversions

Add to Cart.totalConversions

The total number of all conversions (clicks or views) for the ‘Add to Cart’ conversion event.

metric

Add to Cart.totalCpa

Add to Cart.totalCpa

The average Cost Per Acquisition (CPA) calculated for all conversions (clicks or views) for the ‘Add to Cart’ conversion event.

metric

Add to Cart.totalRoas

Add to Cart.totalRoas

The total Return On Ad Spend (ROAS), calculated as the total conversion value attributed to clicks or views divided by the spend for the ‘Add to Cart’ conversion event.

metric

Add to Cart.totalSumValue

Add to Cart.totalSumValue

The total monetary value reported for all conversions (clicks or views) for the ‘Add to Cart’ conversion event.

metric

Add to Cart.viewAverageValue

Add to Cart.viewAverageValue

The average monetary value reported for view-through conversions for the ‘Add to Cart’ conversion event.

metric

Add to Cart.viewConversionRate

Add to Cart.viewConversionRate

The average percentage rate of view-through conversions per viewable impression for the ‘Add to Cart’ conversion event.

metric

Add to Cart.viewConversions

Add to Cart.viewConversions

The total number of view-through conversions for the ‘Add to Cart’ conversion event.

metric

Add to Cart.viewSumValue

Add to Cart.viewSumValue

The total monetary value reported for view-through conversions for the ‘Add to Cart’ conversion event.

metric

ContentView.averageValue

ContentView.averageValue

The average monetary value reported for conversions from clicks for the ‘ContentView’ conversion event.

metric

ContentView.conversionRate

ContentView.conversionRate

The average percentage rate of conversions from clicks per click for the ‘ContentView’ conversion event.

metric

ContentView.conversions

ContentView.conversions

The total number of conversions attributed to clicks for the ‘ContentView’ conversion event.

metric

ContentView.cpa

ContentView.cpa

The average Cost Per Acquisition (CPA) for conversions attributed to clicks for the ‘ContentView’ conversion event.

metric

ContentView.roas

ContentView.roas

The Return On Ad Spend (ROAS), calculated as the total conversion value attributed to clicks divided by the spend for the ‘ContentView’ conversion event.

metric

ContentView.sumValue

ContentView.sumValue

The total monetary value reported for conversions from clicks for the ‘ContentView’ conversion event.

metric

ContentView.totalAverageValue

ContentView.totalAverageValue

The average monetary value reported for all conversions (clicks or views) for the ‘ContentView’ conversion event.

metric

ContentView.totalConversions

ContentView.totalConversions

The total number of all conversions (clicks or views) for the ‘ContentView’ conversion event.

metric

ContentView.totalCpa

ContentView.totalCpa

The average Cost Per Acquisition (CPA) calculated for all conversions (clicks or views) for the ‘ContentView’ conversion event.

metric

ContentView.totalRoas

ContentView.totalRoas

The total Return On Ad Spend (ROAS), calculated as the total conversion value attributed to clicks or views divided by the spend for the ‘ContentView’ conversion event.

metric

ContentView.totalSumValue

ContentView.totalSumValue

The total monetary value reported for all conversions (clicks or views) for the ‘ContentView’ conversion event.

metric

ContentView.viewAverageValue

ContentView.viewAverageValue

The average monetary value reported for view-through conversions for the ‘ContentView’ conversion event.

metric

ContentView.viewConversionRate

ContentView.viewConversionRate

The average percentage rate of view-through conversions per viewable impression for the ‘ContentView’ conversion event.

metric

ContentView.viewConversions

ContentView.viewConversions

The total number of view-through conversions for the ‘ContentView’ conversion event.

metric

ContentView.viewSumValue

ContentView.viewSumValue

The total monetary value reported for view-through conversions for the ‘ContentView’ conversion event.

metric

Country

country

The country associated with geographic targeting or performance data.

dimension

Date

Date

The date of the report or metric breakdown.

dimension

Page view.averageValue

Page view.averageValue

The average monetary value reported for conversions from clicks for the ‘Page view’ conversion event.

metric

Page view.conversionRate

Page view.conversionRate

The average percentage rate of conversions from clicks per click for the ‘Page view’ conversion event.

metric

Page view.conversions

Page view.conversions

The total number of conversions attributed to clicks for the ‘Page view’ conversion event.

metric

Page view.cpa

Page view.cpa

The average Cost Per Acquisition (CPA) for conversions attributed to clicks for the ‘Page view’ conversion event.

metric

Page view.sumValue

Page view.sumValue

The total monetary value reported for conversions from clicks for the ‘Page view’ conversion event.

metric

Page view.totalAverageValue

Page view.totalAverageValue

The average monetary value reported for all conversions (clicks or views) for the ‘Page view’ conversion event.

metric

Page view.totalConversions

Page view.totalConversions

The total number of all conversions (clicks or views) for the ‘Page view’ conversion event.

metric

Page view.totalCpa

Page view.totalCpa

The average Cost Per Acquisition (CPA) calculated for all conversions (clicks or views) for the ‘Page view’ conversion event.

metric

Page view.totalSumValue

Page view.totalSumValue

The total monetary value reported for all conversions (clicks or views) for the ‘Page view’ conversion event.

metric

Page view.viewAverageValue

Page view.viewAverageValue

The average monetary value reported for view-through conversions for the ‘Page view’ conversion event.

metric

Page view.viewConversionRate

Page view.viewConversionRate

The average percentage rate of view-through conversions per viewable impression for the ‘Page view’ conversion event.

metric

Page view.viewConversions

Page view.viewConversions

The total number of view-through conversions for the ‘Page view’ conversion event.

metric

Page view.viewSumValue

Page view.viewSumValue

The total monetary value reported for view-through conversions for the ‘Page view’ conversion event.

metric

Registration.averageValue

Registration.averageValue

The average monetary amount reported for conversions from clicks specifically for ‘Registration’ events.

metric

Registration.conversionRate

Registration.conversionRate

The average rate of conversions from clicks per click percentage, specifically for ‘Registration’ events.

metric

Registration.conversions

Registration.conversions

The total number of conversions from clicks across the entire query range, specifically for ‘Registration’ events.

metric

Registration.cpa

Registration.cpa

The average Cost Per Acquisition (CPA) calculated for conversions from clicks, specifically for ‘Registration’ events.

metric

Registration.roas

Registration.roas

Return On Ad Spend (ROAS) calculated as total conversion value attributed to clicks, divided by spend, specifically for ‘Registration’ events.

metric

Registration.sumValue

Registration.sumValue

The total monetary amount reported for conversions from clicks, specifically for ‘Registration’ events.

metric

Registration.totalAverageValue

Registration.totalAverageValue

The average monetary amount reported for all conversions (including view-through), specifically for ‘Registration’ events.

metric

Registration.totalConversions

Registration.totalConversions

The total number of all conversions (including view-through) across the entire query range, specifically for ‘Registration’ events.

metric

Registration.totalCpa

Registration.totalCpa

The average Cost Per Acquisition (CPA) calculated for all conversions (including view-through), specifically for ‘Registration’ events.

metric

Registration.totalRoas

Registration.totalRoas

Total Return On Ad Spend (ROAS) calculated as total conversion value attributed to clicks or views, divided by spend, specifically for ‘Registration’ events.

metric

Registration.totalSumValue

Registration.totalSumValue

The total monetary amount reported for all conversions (including view-through) for the entire query range, specifically for ‘Registration’ events.

metric

Registration.viewAverageValue

Registration.viewAverageValue

The average monetary amount reported for view-through conversions, specifically for ‘Registration’ events.

metric

Registration.viewConversionRate

Registration.viewConversionRate

The average rate of view-through conversions per viewable impression percentage, specifically for ‘Registration’ events.

metric

Registration.viewConversions

Registration.viewConversions

The total number of view-through conversions across the entire query range, specifically for ‘Registration’ events.

metric

Registration.viewSumValue

Registration.viewSumValue

The total monetary amount reported for view-through conversions for the entire query range, specifically for ‘Registration’ events.

metric

Report End Date

Report End Date

The end date for the requested report data range.

dimension

Report Start Date

Report Start Date

The start date for the requested report data range.

dimension

VideoView.averageValue

VideoView.averageValue

The average monetary value reported for conversions from clicks for the ‘VideoView’ conversion event.

metric

VideoView.conversionRate

VideoView.conversionRate

The average percentage rate of conversions from clicks per click for the ‘VideoView’ conversion event.

metric

VideoView.conversions

VideoView.conversions

The total number of conversions attributed to clicks for the ‘VideoView’ conversion event.

metric

VideoView.cpa

VideoView.cpa

The average Cost Per Acquisition (CPA) for conversions attributed to clicks for the ‘VideoView’ conversion event.

metric

VideoView.sumValue

VideoView.sumValue

The total monetary value reported for conversions from clicks for the ‘VideoView’ conversion event.

metric

VideoView.totalAverageValue

VideoView.totalAverageValue

The average monetary value reported for all conversions (clicks or views) for the ‘VideoView’ conversion event.

metric

VideoView.totalConversions

VideoView.totalConversions

The total number of all conversions (clicks or views) for the ‘VideoView’ conversion event.

metric

VideoView.totalCpa

VideoView.totalCpa

The average Cost Per Acquisition (CPA) calculated for all conversions (clicks or views) for the ‘VideoView’ conversion event.

metric

VideoView.totalSumValue

VideoView.totalSumValue

The total monetary value reported for all conversions (clicks or views) for the ‘VideoView’ conversion event.

metric

VideoView.viewAverageValue

VideoView.viewAverageValue

The average monetary value reported for view-through conversions for the ‘VideoView’ conversion event.

metric

VideoView.viewConversionRate

VideoView.viewConversionRate

The average percentage rate of view-through conversions per viewable impression for the ‘VideoView’ conversion event.

metric

VideoView.viewConversions

VideoView.viewConversions

The total number of view-through conversions for the ‘VideoView’ conversion event.

metric

VideoView.viewSumValue

VideoView.viewSumValue

The total monetary value reported for view-through conversions for the ‘VideoView’ conversion event.

metric

advertiser_id

advertiser_id

The unique identifier for the advertiser account, referred to as a marketer ID in the Outbrain API.

dimension

approvalStatus.isEditable

approvalStatus.isEditable

A boolean value indicating whether the promoted link can be edited, which is true if its approval review status is pending.

dimension

approvalStatus.status

approvalStatus.status

The current approval status of the promoted link, indicating if it is Approved, Pending review, or Rejected.

dimension

archived

promotedLinkArchived

Designates whether the promoted link is archived.

dimension

averageValue

averageValue

The average monetary amount reported for conversions from clicks.

metric

budget

budget

An object containing details about the budget allocated for a campaign or shared across campaigns.

dimension

budget.amount

budget.amount

The monetary amount of this budget.

metric

budget.amountRemaining

budget.amountRemaining

The unspent monetary amount remaining on this budget.

metric

budget.amountSpent

budget.amountSpent

The monetary amount spent from this budget.

metric

budget.creationTime

budget.creationTime

The time when this budget was created.

dimension

budget.currency

budget.currency

The currency denomination applied to the budget amount.

dimension

budget.dailyTarget

budget.dailyTarget

The maximum monetary amount that is allowed to be spent per day for the budget, relevant for daily target pacing.

metric

budget.endDate

budget.endDate

The date this budget is scheduled to stop spending.

dimension

budget.id

budget.id

The unique identifier of this budget.

dimension

budget.lastModified

budget.lastModified

The last modification date of this budget.

dimension

budget.maximumAmount

budget.maximumAmount

The maximum monetary amount allowed for the budget, if a limit is defined.

metric

budget.name

budget.name

The name of this budget.

dimension

budget.pacing

budget.pacing

Controls how fast the budget will be spent, such as SPEND_ASAP, AUTOMATIC, or DAILY_TARGET.

dimension

budget.runForever

budget.runForever

Designates whether the budget has an end date. If true, the endDate attribute will not be used.

dimension

budget.shared

budget.shared

Indicates whether the budget is shared between multiple campaigns.

dimension

budget.startDate

budget.startDate

The date this budget is scheduled to begin spending.

dimension

budget.type

budget.type

Controls on which period the budget refreshes, such as CAMPAIGN (one-time), MONTHLY, or DAILY.

dimension

cachedImageUrl

promotedLinkCachedImageUrl

The URL of the PromotedLink’s logo image, cached on Outbrain’s servers.

dimension

campaignEnabled

campaignEnabled

Indicates whether the campaign is currently enabled.

dimension

campaignId

campaignId

The unique identifier of the campaign.

dimension

campaignIdentifier

campaignIdentifier

The unique identifier for the campaign.

metric

campaignName

campaignName

The name of the campaign.

dimension

campaignOnAir

campaignOnAir

Indicates whether the campaign is currently active and serving.

dimension

campaignOnAirReason

campaignOnAirReason

The reason for the campaign’s current on-air status, such as campaign disabled, budget capped, or waiting for start hour.

dimension

campaignOptimization.automaticModeMaxAvgDailyCpc

campaignOptimization.automaticModeMaxAvgDailyCpc

The maximum average daily Cost Per Click (CPC) that a campaign is permitted to reach when using MAX_CONVERSION_FULLY_AUTOMATED, TARGET_ROAS_FULLY_AUTOMATED, and TARGET_CPA_FULLY_AUTOMATED optimization types.

metric

campaignOptimization.automaticModeMaxCpc

campaignOptimization.automaticModeMaxCpc

The maximum Cost Per Click (CPC) value a campaign is allowed to reach in automatic optimization modes, specifically for campaigns created before Sep 1st, 2024.

metric

campaignOptimization.baseCpc

campaignOptimization.baseCpc

The latest Cost Per Click (CPC) value updated by the user for campaigns using TARGET_ROAS_FULLY_AUTOMATED, MAX_CONVERSION_FULLY_AUTOMATED, or TARGET_CPA_FULLY_AUTOMATED optimizations.

metric

campaignOptimization.conversions

campaignOptimization.conversions

A list of up to two supportive conversion event IDs that are higher in the conversion funnel than the primary conversion, used for CPC and MAX_CONVERSION_FULLY_AUTOMATED optimization types.

dimension

campaignOptimization.maxCpcAdjustmentOverManualInFullyAutomated

campaignOptimization.maxCpcAdjustmentOverManualInFullyAutomated

The maximum percentage by which the algorithm is allowed to increase the campaign’s Cost Per Click (CPC) in fully automated optimization modes (MAX_CONVERSION_FULLY_AUTOMATED, TARGET_ROAS_FULLY_AUTOMATED, and TARGET_CPA_FULLY_AUTOMATED).

metric

campaignOptimization.maxCpcBidPercentage

campaignOptimization.maxCpcBidPercentage

The maximum percentage allowed per serving above the campaign’s Cost Per Click (CPC). It is mandatory for CPC optimization and defaults to 1 for fully automated optimization types if not specified.

metric

campaignOptimization.maxCpcRecommendation

campaignOptimization.maxCpcRecommendation

A recommendation provided by the algorithm for automatic campaigns when the Cost Per Click (CPC) cannot be increased, suggesting actions like increasing the bid cap or target CPA.

dimension

campaignOptimization.optimizationType

campaignOptimization.optimizationType

The strategy used to optimize the campaign, such as maximizing traffic, optimizing for CPC, or targeting specific CPA or ROAS goals.

dimension

campaignOptimization.targetConversionId

campaignOptimization.targetConversionId

The ID of the primary conversion event that the campaign is optimized towards, relevant for CPC and MAX_CONVERSION_FULLY_AUTOMATED optimization types.

dimension

campaign_name

campaign_name

The name of the campaign.

dimension

campaign_objective

campaign_objective

The primary goal or aim of the campaign, such as Awareness, Traffic, or Conversions.

dimension

category

category

The category of the conversion event, such as PURCHASE, LEAD, or VIDEO_VIEW.

dimension

clicks

clicks

The total number of PromotedLinks clicks across the entire query range.

metric

conversionRate

conversionRate

The average rate of conversions from clicks per click percentage.

metric

conversionWindow

conversionWindow

The time in days from click to conversion that is tracked for a conversion event.

metric

conversions

conversions

The total number of conversions from clicks across the entire query range.

metric

cpa

cpa

The average Cost Per Acquisition (CPA) calculated for conversions from clicks.

metric

cpc

cpc

The cost per click for the campaign or promoted link.

metric

cpm

cpm

Cost per thousand impressions (CPM), calculated by dividing the amount spent by impressions multiplied by 1000.

metric

creationTime

creationTime

The time when the promoted link was created.

dimension

creationTime_date

creationTime_date

The date when the entity (e.g., marketer, campaign, promoted link, budget, or conversion event) was created.

dimension

creativeFormat

creativeFormat

The creative format of the campaign, such as Standard, AppInstall, Carousel, or Clip.

dimension

ctr

ctr

The average Click Through Rate (CTR) percentage, calculated as (clicks / impressions) * 100.

metric

currency

currency

The three-letter ISO 4217 code for the currency used for financial values like budget amounts or conversion order values.

dimension

data_currency

data_currency

The currency in which the performance data is reported. This is tied to the marketer’s budget currency.

dimension

data_source

data_source

The source of the collected data, which is the Outbrain Amplify API.

dimension

dstFeeCost

dstFeeCost

The Digital Services Tax (DST) added in some targeted countries.

metric

ecpc

ecpc

The effective (calculated) average Cost Per Click (CPC), calculated as spend / clicks.

metric

enabled

enabled

Designates whether this promoted link will be served.

dimension

fromDate

fromDate

The first day of the result date period for a report.

dimension

geoCode

geoCode

The code identifying the geographic entity.

dimension

geoId

geoId

The unique identifier of the geographic entity.

dimension

geoName

geoName

The name of the geographic entity.

dimension

id

id

A unique identifier for an entity such as a marketer, budget, campaign, or promoted link.

dimension

identifier

identifier

A unique identifier for the data record, which could represent a campaign, promoted link, or another entity.

metric

imageMetadata.id

imageMetadata.id

The unique identifier for the image associated with a promoted link.

dimension

imageMetadata.originalImageUrl

imageMetadata.originalImageUrl

The URL of the image with its original dimensions, as provided by Outbrain.

dimension

imageMetadata.requestedImageUrl

imageMetadata.requestedImageUrl

The URL of the image formatted to the requested dimensions for a promoted link.

dimension

impressions

impressions

The total number of PromotedLinks impressions across the entire query range.

metric

includeInConversions

includeInConversions

Indicates whether a conversion event is included in total conversions reporting.

dimension

lastModified

promotedLinkLastModified

The time when the promoted link was last modified.

dimension

lastModified_date

lastModified_date

The date when the entity (e.g., marketer, campaign, promoted link, budget, or conversion event) was last modified.

dimension

marketerId

marketerId

The unique identifier of the marketer account.

dimension

marketerName

marketerName

The name of the marketer account.

dimension

name

name

The descriptive name of an entity such as a marketer, budget, campaign, or conversion event.

dimension

objective

objective

The objective of the campaign, such as Awareness, Traffic, Conversions, or AppInstalls.

dimension

platform

platform

The platform where the content was consumed, such as DESKTOP, MOBILE, or TABLET.

dimension

promotedLinkId

promotedLinkId

The unique identifier of the promoted link.

dimension

publisherId

publisherId

The unique identifier of the publisher.

dimension

publisherName

publisherName

The name of the publisher.

dimension

publisher_name

publisher_name

The name of the publisher where the promoted content appeared.

dimension

roas

roas

Return On Ad Spend (ROAS) calculated as total conversion value attributed to clicks, divided by spend.

metric

sectionId

sectionId

The unique identifier of the section within a publisher’s site.

dimension

sectionName

sectionName

The name of the section of the site where the PromotedLink URL points to.

dimension

segment

segment

The conversion segment associated with an event, if it exists.

dimension

spend

spend

The total amount of money spent across the entire query range.

metric

status

promotedLinkStatus

The review status of the promoted link. This field is deprecated; use approvalStatus instead.

dimension

sumValue

sumValue

The total monetary amount reported for conversions from clicks.

metric

targetingStatus

targetingStatus

The status indicating how an entity, such as an audience interest, is being targeted (e.g., targeted, excluded, not targeted, or partially excluded).

dimension

text

promotedLinkText

The text or headline of the promoted link.

dimension

title

title

The headline or title text for the promoted content or promoted link sequence.

dimension

toDate

toDate

The last day (inclusive) of the result date period for a report.

dimension

totalAverageValue

totalAverageValue

The average monetary amount reported for all conversions (including view-through).

metric

totalConversions

totalConversions

The total number of all conversions (including view-through) across the entire query range.

metric

totalCpa

totalCpa

The average Cost Per Acquisition (CPA) calculated for all conversions (including view-through).

metric

totalRoas

totalRoas

Total Return On Ad Spend (ROAS) calculated as total conversion value attributed to clicks or views, divided by spend.

metric

totalSumValue

totalSumValue

The total monetary amount reported for all conversions (including view-through) for the entire query range.

metric

trackingStatus

trackingStatus

Indicates the tracking status of the conversion event or segment, such as active or inactive.

dimension

type

type

This field indicates the report type from which the data was collected. The Outbrain Amplify API provides various report types, such as Campaigns, Periodic Content, Publishers, Sections, Geo by Campaign, Platforms by Campaign, Conversion Events, Interest Performance, and Promoted Content, each offering different performance metrics and metadata.

dimension

url

promotedLinkUrl

The URL visitors will be sent to upon clicking the promoted link.

dimension

viewAverageValue

viewAverageValue

The average monetary amount reported for view-through conversions.

metric

viewConversionRate

viewConversionRate

The average rate of view-through conversions per viewable impression percentage.

metric

viewConversions

viewConversions

The total number of view-through conversions across the entire query range.

metric

viewSumValue

viewSumValue

The total monetary amount reported for view-through conversions for the entire query range.

metric