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 |
|---|---|---|---|
Country |
country |
The country associated with geographic targeting or performance data. |
dimension |
Date |
Date |
The date of the report or metric breakdown. |
dimension |
Engagement.averageValue |
Engagement.averageValue |
The average monetary value reported for conversions categorized as ‘Engagement’. |
metric |
Engagement.conversionRate |
Engagement.conversionRate |
The average rate of conversions from clicks for conversions categorized as ‘Engagement’. |
metric |
Engagement.conversions |
Engagement.conversions |
The total number of conversions from clicks for conversions categorized as ‘Engagement’. |
metric |
Engagement.cpa |
Engagement.cpa |
The average Cost Per Acquisition (CPA) calculated for conversions from clicks for conversions categorized as ‘Engagement’. |
metric |
Engagement.sumValue |
Engagement.sumValue |
The total monetary amount reported for conversions from clicks for conversions categorized as ‘Engagement’. |
metric |
Engagement.totalAverageValue |
Engagement.totalAverageValue |
The average monetary value reported for all conversions (including view-through) for conversions categorized as ‘Engagement’. |
metric |
Engagement.totalConversions |
Engagement.totalConversions |
The total number of all conversions (including view-through) for conversions categorized as ‘Engagement’. |
metric |
Engagement.totalCpa |
Engagement.totalCpa |
The average Cost Per Acquisition (CPA) calculated for all conversions (including view-through) for conversions categorized as ‘Engagement’. |
metric |
Engagement.totalSumValue |
Engagement.totalSumValue |
The total monetary amount reported for all conversions (including view-through) for conversions categorized as ‘Engagement’. |
metric |
Engagement.viewAverageValue |
Engagement.viewAverageValue |
The average monetary value reported for view-through conversions for conversions categorized as ‘Engagement’. |
metric |
Engagement.viewConversionRate |
Engagement.viewConversionRate |
The average rate of view-through conversions per viewable impression for conversions categorized as ‘Engagement’. |
metric |
Engagement.viewConversions |
Engagement.viewConversions |
The total number of view-through conversions for conversions categorized as ‘Engagement’. |
metric |
Engagement.viewSumValue |
Engagement.viewSumValue |
The total monetary amount reported for view-through conversions for conversions categorized as ‘Engagement’. |
metric |
Install.averageValue |
Install.averageValue |
The average monetary value reported for conversions categorized as ‘Install’. |
metric |
Install.conversionRate |
Install.conversionRate |
The average rate of conversions from clicks for conversions categorized as ‘Install’. |
metric |
Install.conversions |
Install.conversions |
The total number of conversions from clicks for conversions categorized as ‘Install’. |
metric |
Install.cpa |
Install.cpa |
The average Cost Per Acquisition (CPA) calculated for conversions from clicks for conversions categorized as ‘Install’. |
metric |
Install.sumValue |
Install.sumValue |
The total monetary amount reported for conversions from clicks for conversions categorized as ‘Install’. |
metric |
Install.totalAverageValue |
Install.totalAverageValue |
The average monetary value reported for all conversions (including view-through) for conversions categorized as ‘Install’. |
metric |
Install.totalConversions |
Install.totalConversions |
The total number of all conversions (including view-through) for conversions categorized as ‘Install’. |
metric |
Install.totalCpa |
Install.totalCpa |
The average Cost Per Acquisition (CPA) calculated for all conversions (including view-through) for conversions categorized as ‘Install’. |
metric |
Install.totalSumValue |
Install.totalSumValue |
The total monetary amount reported for all conversions (including view-through) for conversions categorized as ‘Install’. |
metric |
Install.viewAverageValue |
Install.viewAverageValue |
The average monetary value reported for view-through conversions for conversions categorized as ‘Install’. |
metric |
Install.viewConversionRate |
Install.viewConversionRate |
The average rate of view-through conversions per viewable impression for conversions categorized as ‘Install’. |
metric |
Install.viewConversions |
Install.viewConversions |
The total number of view-through conversions for conversions categorized as ‘Install’. |
metric |
Install.viewSumValue |
Install.viewSumValue |
The total monetary amount reported for view-through conversions for conversions categorized as ‘Install’. |
metric |
Lead.totalCpa |
Lead.totalCpa |
The average Cost Per Acquisition (CPA) calculated for all conversions (including view-through) for conversions categorized as ‘Lead’. |
metric |
Lead.totalRoas |
Lead.totalRoas |
The Total Return On Ad Spend (ROAS) calculated for all conversions (including view-through) for conversions categorized as ‘Lead’. |
metric |
Lead.totalSumValue |
Lead.totalSumValue |
The total monetary amount reported for all conversions (including view-through) for conversions categorized as ‘Lead’. |
metric |
Lead.viewAverageValue |
Lead.viewAverageValue |
The average monetary value reported for view-through conversions for conversions categorized as ‘Lead’. |
metric |
Lead.viewConversionRate |
Lead.viewConversionRate |
The average rate of view-through conversions per viewable impression for conversions categorized as ‘Lead’. |
metric |
Lead.viewConversions |
Lead.viewConversions |
The total number of view-through conversions for conversions categorized as ‘Lead’. |
metric |
Lead.viewSumValue |
Lead.viewSumValue |
The total monetary amount reported for view-through conversions for conversions categorized as ‘Lead’. |
metric |
Page view.averageValue |
Page view.averageValue |
The average monetary value reported for conversions categorized as ‘Page view’. |
metric |
Page view.conversionRate |
Page view.conversionRate |
The average rate of conversions from clicks for conversions categorized as ‘Page view’. |
metric |
Page view.conversions |
Page view.conversions |
The total number of conversions from clicks for conversions categorized as ‘Page view’. |
metric |
Page view.cpa |
Page view.cpa |
The average Cost Per Acquisition (CPA) calculated for conversions from clicks for conversions categorized as ‘Page view’. |
metric |
Page view.sumValue |
Page view.sumValue |
The total monetary amount reported for conversions from clicks for conversions categorized as ‘Page view’. |
metric |
Page view.totalAverageValue |
Page view.totalAverageValue |
The average monetary value reported for all conversions (including view-through) for conversions categorized as ‘Page view’. |
metric |
Page view.totalConversions |
Page view.totalConversions |
The total number of all conversions (including view-through) for conversions categorized as ‘Page view’. |
metric |
Page view.totalCpa |
Page view.totalCpa |
The average Cost Per Acquisition (CPA) calculated for all conversions (including view-through) for conversions categorized as ‘Page view’. |
metric |
Page view.totalSumValue |
Page view.totalSumValue |
The total monetary amount reported for all conversions (including view-through) for conversions categorized as ‘Page view’. |
metric |
Page view.viewAverageValue |
Page view.viewAverageValue |
The average monetary value reported for view-through conversions for conversions categorized as ‘Page view’. |
metric |
Page view.viewConversionRate |
Page view.viewConversionRate |
The average rate of view-through conversions per viewable impression for conversions categorized as ‘Page view’. |
metric |
Page view.viewConversions |
Page view.viewConversions |
The total number of view-through conversions for conversions categorized as ‘Page view’. |
metric |
Page view.viewSumValue |
Page view.viewSumValue |
The total monetary amount reported for view-through conversions for conversions categorized as ‘Page view’. |
metric |
Publisher |
Publisher |
The name of the content site where Outbrain recommendations appear. |
dimension |
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 |
VIDEO ENGAGED VIEW.averageValue |
VIDEO ENGAGED VIEW.averageValue |
The average monetary value attributed to conversions for the ‘Video Engaged View’ event. This metric is part of detailed conversion reporting. |
metric |
VIDEO ENGAGED VIEW.conversionRate |
VIDEO ENGAGED VIEW.conversionRate |
The average conversion rate for clicks leading to the ‘Video Engaged View’ event, expressed as a percentage. This metric is part of detailed conversion reporting. |
metric |
VIDEO ENGAGED VIEW.conversions |
VIDEO ENGAGED VIEW.conversions |
The total number of conversions from clicks attributed to the ‘Video Engaged View’ event. This metric is part of detailed conversion reporting. |
metric |
VIDEO ENGAGED VIEW.cpa |
VIDEO ENGAGED VIEW.cpa |
The average Cost Per Acquisition (CPA) for conversions from clicks for the ‘Video Engaged View’ event. This metric is part of detailed conversion reporting. |
metric |
VIDEO ENGAGED VIEW.sumValue |
VIDEO ENGAGED VIEW.sumValue |
The total monetary value reported for conversions from clicks for the ‘Video Engaged View’ event. This metric is part of detailed conversion reporting. |
metric |
VIDEO ENGAGED VIEW.totalAverageValue |
VIDEO ENGAGED VIEW.totalAverageValue |
The average monetary value reported for all conversions (clicks and view-through) for the ‘Video Engaged View’ event. This metric is part of detailed conversion reporting. |
metric |
VIDEO ENGAGED VIEW.totalConversions |
VIDEO ENGAGED VIEW.totalConversions |
The total number of all conversions (clicks and view-through) for the ‘Video Engaged View’ event. This metric is part of detailed conversion reporting. |
metric |
VIDEO ENGAGED VIEW.totalCpa |
VIDEO ENGAGED VIEW.totalCpa |
The average Cost Per Acquisition (CPA) calculated for all conversions (clicks and view-through) for the ‘Video Engaged View’ event. This metric is part of detailed conversion reporting. |
metric |
VIDEO ENGAGED VIEW.totalSumValue |
VIDEO ENGAGED VIEW.totalSumValue |
The total monetary value reported for all conversions (clicks and view-through) for the ‘Video Engaged View’ event. This metric is part of detailed conversion reporting. |
metric |
VIDEO ENGAGED VIEW.viewAverageValue |
VIDEO ENGAGED VIEW.viewAverageValue |
The average monetary value reported for view-through conversions for the ‘Video Engaged View’ event. This metric is part of detailed conversion reporting. |
metric |
VIDEO ENGAGED VIEW.viewConversionRate |
VIDEO ENGAGED VIEW.viewConversionRate |
The average rate of view-through conversions per viewable impression for the ‘Video Engaged View’ event, expressed as a percentage. This metric is part of detailed conversion reporting. |
metric |
VIDEO ENGAGED VIEW.viewConversions |
VIDEO ENGAGED VIEW.viewConversions |
The total number of view-through conversions attributed to the ‘Video Engaged View’ event. This metric is part of detailed conversion reporting. |
metric |
VIDEO ENGAGED VIEW.viewSumValue |
VIDEO ENGAGED VIEW.viewSumValue |
The total monetary value reported for view-through conversions for the ‘Video Engaged View’ event. This metric is part of detailed conversion reporting. |
metric |
VideoAdStarted.averageValue |
VideoAdStarted.averageValue |
The average monetary value attributed to conversions for the ‘Video Ad Started’ event. This metric is part of detailed conversion reporting. |
metric |
VideoAdStarted.conversionRate |
VideoAdStarted.conversionRate |
The average conversion rate for clicks leading to the ‘Video Ad Started’ event, expressed as a percentage. This metric is part of detailed conversion reporting. |
metric |
VideoAdStarted.conversions |
VideoAdStarted.conversions |
The total number of conversions from clicks attributed to the ‘Video Ad Started’ event. This metric is part of detailed conversion reporting. |
metric |
VideoAdStarted.cpa |
VideoAdStarted.cpa |
The average Cost Per Acquisition (CPA) for conversions from clicks for the ‘Video Ad Started’ event. This metric is part of detailed conversion reporting. |
metric |
VideoAdStarted.sumValue |
VideoAdStarted.sumValue |
The total monetary value reported for conversions from clicks for the ‘Video Ad Started’ event. This metric is part of detailed conversion reporting. |
metric |
VideoAdStarted.totalAverageValue |
VideoAdStarted.totalAverageValue |
The average monetary value reported for all conversions (clicks and view-through) for the ‘Video Ad Started’ event. This metric is part of detailed conversion reporting. |
metric |
VideoAdStarted.totalConversions |
VideoAdStarted.totalConversions |
The total number of all conversions (clicks and view-through) for the ‘Video Ad Started’ event. This metric is part of detailed conversion reporting. |
metric |
VideoAdStarted.totalCpa |
VideoAdStarted.totalCpa |
The average Cost Per Acquisition (CPA) calculated for all conversions (clicks and view-through) for the ‘Video Ad Started’ event. This metric is part of detailed conversion reporting. |
metric |
VideoAdStarted.totalSumValue |
VideoAdStarted.totalSumValue |
The total monetary value reported for all conversions (clicks and view-through) for the ‘Video Ad Started’ event. This metric is part of detailed conversion reporting. |
metric |
VideoAdStarted.viewAverageValue |
VideoAdStarted.viewAverageValue |
The average monetary value reported for view-through conversions for the ‘Video Ad Started’ event. This metric is part of detailed conversion reporting. |
metric |
VideoAdStarted.viewConversionRate |
VideoAdStarted.viewConversionRate |
The average rate of view-through conversions per viewable impression for the ‘Video Ad Started’ event, expressed as a percentage. This metric is part of detailed conversion reporting. |
metric |
VideoAdStarted.viewConversions |
VideoAdStarted.viewConversions |
The total number of view-through conversions attributed to the ‘Video Ad Started’ event. This metric is part of detailed conversion reporting. |
metric |
VideoAdStarted.viewSumValue |
VideoAdStarted.viewSumValue |
The total monetary value reported for view-through conversions for the ‘Video Ad Started’ event. This metric is part of detailed conversion reporting. |
metric |
VideoView.averageValue |
VideoView.averageValue |
The average monetary value reported for conversions categorized as ‘VideoView’. |
metric |
VideoView.conversionRate |
VideoView.conversionRate |
The average rate of conversions from clicks for conversions categorized as ‘VideoView’. |
metric |
VideoView.conversions |
VideoView.conversions |
The total number of conversions from clicks for conversions categorized as ‘VideoView’. |
metric |
VideoView.cpa |
VideoView.cpa |
The average Cost Per Acquisition (CPA) calculated for conversions from clicks for conversions categorized as ‘VideoView’. |
metric |
VideoView.sumValue |
VideoView.sumValue |
The total monetary amount reported for conversions from clicks for conversions categorized as ‘VideoView’. |
metric |
VideoView.totalAverageValue |
VideoView.totalAverageValue |
The average monetary value reported for all conversions (including view-through) for conversions categorized as ‘VideoView’. |
metric |
VideoView.totalConversions |
VideoView.totalConversions |
The total number of all conversions (including view-through) for conversions categorized as ‘VideoView’. |
metric |
VideoView.totalCpa |
VideoView.totalCpa |
The average Cost Per Acquisition (CPA) calculated for all conversions (including view-through) for conversions categorized as ‘VideoView’. |
metric |
VideoView.totalSumValue |
VideoView.totalSumValue |
The total monetary amount reported for all conversions (including view-through) for conversions categorized as ‘VideoView’. |
metric |
VideoView.viewAverageValue |
VideoView.viewAverageValue |
The average monetary value reported for view-through conversions for conversions categorized as ‘VideoView’. |
metric |
VideoView.viewConversionRate |
VideoView.viewConversionRate |
The average rate of view-through conversions per viewable impression for conversions categorized as ‘VideoView’. |
metric |
VideoView.viewConversions |
VideoView.viewConversions |
The total number of view-through conversions for conversions categorized as ‘VideoView’. |
metric |
VideoView.viewSumValue |
VideoView.viewSumValue |
The total monetary amount reported for view-through conversions for conversions categorized as ‘VideoView’. |
metric |
advertiser |
advertiser |
The unique identifier of the advertiser, also referred to as a Marketer ID, representing a customer account on the Outbrain platform. |
dimension |
advertiser_id |
advertiser_id |
The unique identifier for the advertiser (marketer) account. |
dimension |
approvalStatus.isEditable |
approvalStatus.isEditable |
Indicates if the PromotedLink’s content is able to be edited. |
dimension |
approvalStatus.status |
approvalStatus.status |
The approval status of the promoted link’s content, such as Approved, Pending, 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 |
awareness.averageValue |
awareness.averageValue |
The average monetary value attributed to conversions or goals set for campaigns with an ‘Awareness’ objective. This metric is part of detailed conversion reporting. |
metric |
awareness.conversionRate |
awareness.conversionRate |
The average conversion rate for clicks leading to the ‘Awareness’ objective, expressed as a percentage. This metric is part of detailed conversion reporting. |
metric |
awareness.conversions |
awareness.conversions |
The total number of conversions from clicks attributed to the ‘Awareness’ objective. This metric is part of detailed conversion reporting. |
metric |
awareness.cpa |
awareness.cpa |
The average Cost Per Acquisition (CPA) for conversions from clicks for the ‘Awareness’ objective. This metric is part of detailed conversion reporting. |
metric |
awareness.sumValue |
awareness.sumValue |
The total monetary value reported for conversions from clicks for the ‘Awareness’ objective. This metric is part of detailed conversion reporting. |
metric |
awareness.totalAverageValue |
awareness.totalAverageValue |
The average monetary value reported for all conversions (clicks and view-through) for the ‘Awareness’ objective. This metric is part of detailed conversion reporting. |
metric |
awareness.totalConversions |
awareness.totalConversions |
The total number of all conversions (clicks and view-through) for the ‘Awareness’ objective. This metric is part of detailed conversion reporting. |
metric |
awareness.totalCpa |
awareness.totalCpa |
The average Cost Per Acquisition (CPA) calculated for all conversions (clicks and view-through) for the ‘Awareness’ objective. This metric is part of detailed conversion reporting. |
metric |
awareness.totalSumValue |
awareness.totalSumValue |
The total monetary value reported for all conversions (clicks and view-through) for the ‘Awareness’ objective. This metric is part of detailed conversion reporting. |
metric |
awareness.viewAverageValue |
awareness.viewAverageValue |
The average monetary value reported for view-through conversions for the ‘Awareness’ objective. This metric is part of detailed conversion reporting. |
metric |
awareness.viewConversionRate |
awareness.viewConversionRate |
The average rate of view-through conversions per viewable impression for the ‘Awareness’ objective, expressed as a percentage. This metric is part of detailed conversion reporting. |
metric |
awareness.viewConversions |
awareness.viewConversions |
The total number of view-through conversions attributed to the ‘Awareness’ objective. This metric is part of detailed conversion reporting. |
metric |
awareness.viewSumValue |
awareness.viewSumValue |
The total monetary value reported for view-through conversions for the ‘Awareness’ objective. This metric is part of detailed conversion reporting. |
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 amount of money allowed to be spent per day for budgets with ‘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 this budget, if defined. This is a read-only field. |
dimension |
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 |
budgetAmount |
budgetAmount |
The total monetary amount allocated for a budget. |
metric |
budgetAmountRemaining |
budgetAmountRemaining |
The unspent monetary amount remaining in the budget. |
metric |
budgetAmountSpent |
budgetAmountSpent |
The total monetary amount spent from the budget. |
metric |
budgetCreationTime |
budgetCreationTime |
The date and time when the budget was created. |
dimension |
budgetCurrency |
budgetCurrency |
The currency denomination applied to the budget amount, such as USD. |
dimension |
budgetEndDate |
budgetEndDate |
The scheduled date when this budget is set to stop spending. |
dimension |
budgetId |
budgetId |
The unique identifier of the budget. |
dimension |
budgetLastModified |
budgetLastModified |
The date and time when the budget was last modified. |
dimension |
budgetName |
budgetName |
The name assigned to the budget. |
dimension |
budgetPacing |
budgetPacing |
Controls the spending rate of the budget, such as ‘AUTOMATIC’ or ‘SPEND_ASAP’. |
dimension |
budgetRunForever |
budgetRunForever |
Indicates whether the budget has an indefinite end date (true) or a specified end date (false). |
dimension |
budgetShared |
budgetShared |
Indicates whether the budget is shared across multiple campaigns. |
dimension |
budgetStartDate |
budgetStartDate |
The scheduled date when this budget is set to begin spending. |
dimension |
budgetType |
budgetType |
The type of budget, controlling its refresh period (e.g., ‘DAILY’, ‘MONTHLY’, ‘CAMPAIGN’). |
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 of 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 |
For MAX_CONVERSION_FULLY_AUTOMATED, TARGET_ROAS_FULLY_AUTOMATED, and TARGET_CPA_FULLY_AUTOMATED optimizations, this is the maximum average daily value that the campaign’s CPC is allowed to reach. |
metric |
campaignOptimization.automaticModeMaxCpc |
campaignOptimization.automaticModeMaxCpc |
For some older MAX_CONVERSION_FULLY_AUTOMATED, TARGET_ROAS_FULLY_AUTOMATED, and TARGET_CPA_FULLY_AUTOMATED optimizations, this is the maximum value that the campaign’s CPC is allowed to reach (Bid Cap). |
metric |
campaignOptimization.baseCpc |
campaignOptimization.baseCpc |
The latest Cost Per Click (CPC) update done by the user for campaigns with certain optimization types (TARGET_ROAS_FULLY_AUTOMATED, MAX_CONVERSION_FULLY_AUTOMATED, TARGET_CPA_FULLY_AUTOMATED). |
metric |
campaignOptimization.conversions |
campaignOptimization.conversions |
A list of up to two supportive conversion event IDs, which are conversions that are earlier in the funnel than the primary conversion, used for CPC and MAX_CONVERSION_FULLY_AUTOMATED optimization. |
dimension |
campaignOptimization.maxCpcAdjustmentOverManualInFullyAutomated |
campaignOptimization.maxCpcAdjustmentOverManualInFullyAutomated |
For MAX_CONVERSION_FULLY_AUTOMATED, TARGET_ROAS_FULLY_AUTOMATED, and TARGET_CPA_FULLY_AUTOMATED optimization, this is the maximal percentage the algorithm is allowed to raise the campaign’s CPC. |
metric |
campaignOptimization.maxCpcBidPercentage |
campaignOptimization.maxCpcBidPercentage |
For CPC optimization, this is mandatory and must be greater than 0.3. For MAX_CONVERSION_FULLY_AUTOMATED, TARGET_ROAS_FULLY_AUTOMATED, and TARGET_CPA_FULLY_AUTOMATED optimization, it defaults to 1 and must be greater than 1 if provided, representing the maximal percentage allowed per serving above the campaign CPC. |
metric |
campaignOptimization.maxCpcRecommendation |
campaignOptimization.maxCpcRecommendation |
An indication from the Outbrain algorithm if it recommends increasing the max average CPC (bid cap) for automatic campaigns, along with reasons. |
dimension |
campaignOptimization.optimizationType |
campaignOptimization.optimizationType |
The type of optimization for the campaign, such as TRAFFIC, CPC, MAX_CONVERSION_FULLY_AUTOMATED, TARGET_CPA_FULLY_AUTOMATED, or TARGET_ROAS_FULLY_AUTOMATED. |
dimension |
campaignOptimization.targetConversionId |
campaignOptimization.targetConversionId |
The primary conversion event ID towards which the campaign is optimized for CPC and MAX_CONVERSION_FULLY_AUTOMATED optimization types. |
dimension |
campaign_id |
campaign_id |
The unique identifier of the campaign. |
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 |
clickout.totalAverageValue |
clickout.totalAverageValue |
The average amount of money reported for all conversions attributed to clicks or views for the entire query range. |
metric |
clickout.totalConversions |
clickout.totalConversions |
The total number of conversions attributed to clicks or views across the entire query range. |
metric |
clickout.totalCpa |
clickout.totalCpa |
The average Cost Per Acquisition (CPA) calculated for all conversions (clicks or views) across the entire query range. |
metric |
clickout.totalRoas |
clickout.totalRoas |
The total Return On Ad Spend (ROAS), which is the total conversion value attributed to clicks or views, divided by the total spend for the entire query range. |
metric |
clickout.totalSumValue |
clickout.totalSumValue |
The total amount of money reported for all conversions (clicks or views) for the entire query range. |
metric |
clickout.viewAverageValue |
clickout.viewAverageValue |
The average amount of money reported for view-through conversions across the entire query range. |
metric |
clickout.viewConversionRate |
clickout.viewConversionRate |
The average rate of view-through conversions per viewable impression percentage across the entire query range. |
metric |
clickout.viewConversions |
clickout.viewConversions |
The total number of view-through conversions across the entire query range. |
metric |
clickout.viewSumValue |
clickout.viewSumValue |
The total amount of money reported for view-through conversions for the entire query range. |
metric |
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 |
promotedLinkCreationTime |
The time when the promoted link was created. |
dimension |
creationTime_date |
creationTime_date |
The date when an entity 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 3-letter ISO 4217 currency code used for monetary 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 |
date |
date |
The specific date for which performance data is reported. |
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 |
promotedLinkEnabled |
Designates whether this promoted link will be served. |
dimension |
engagementTimeSpentOnPage |
engagementTimeSpentOnPage |
The total time users spent on pages, often associated with engagement conversion events like ‘Time On Page’. This is likely a derived metric from conversion event settings. |
metric |
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 a specific entity such as a Marketer, Campaign, PromotedLink, or Conversion Event. |
metric |
imageMetadata.id |
imageMetadata.id |
The unique identifier of the image used for the promoted link. |
dimension |
imageMetadata.originalImageUrl |
imageMetadata.originalImageUrl |
The URL of the original image associated with the promoted link, before any dimension adjustments. |
dimension |
imageMetadata.requestedImageUrl |
imageMetadata.requestedImageUrl |
The URL of the image associated with the promoted link, with the requested dimensions. |
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 |
internalId |
internalId |
A unique identifier for an internal entity, such as a promoted link, campaign, or other reportable item. This often corresponds to the ‘id’ field in various API objects. |
metric |
lastModified |
promotedLinkLastModified |
The time when the promoted link was last modified. |
dimension |
lastModified_date |
lastModified_date |
The date and time when the entity (e.g., campaign, budget, promoted link) was last modified. |
dimension |
loaded_at |
loaded_at |
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 |
onAirReason |
campaignOnAirReason |
The reason for a campaign’s current ‘on-air’ status, such as ‘CAMPAIGN_ON_AIR’ or ‘CAMPAIGN_DAILY_CAPPED’. |
dimension |
orderValue |
orderValue |
The monetary value associated with a specific conversion event, used to track overall Return On Investment (ROI). |
dimension |
platform |
platform |
The platform where the content was consumed, such as DESKTOP, MOBILE, or TABLET. |
dimension |
premiumPurchase.viewAverageValue |
premiumPurchase.viewAverageValue |
The average amount of money reported for view-through conversions specifically for the ‘premiumPurchase’ conversion pixel. |
metric |
premiumPurchase.viewConversionRate |
premiumPurchase.viewConversionRate |
The average rate of view-through conversions per viewable impression percentage specifically for the ‘premiumPurchase’ conversion pixel. |
metric |
premiumPurchase.viewConversions |
premiumPurchase.viewConversions |
The total number of view-through conversions specifically for the ‘premiumPurchase’ conversion pixel. |
metric |
premiumPurchase.viewSumValue |
premiumPurchase.viewSumValue |
The total amount of money reported for view-through conversions specifically for the ‘premiumPurchase’ conversion pixel. |
metric |
promotedLinkId |
promotedLinkId |
The unique identifier of the promoted link. |
dimension |
publisher |
publisher |
The name of the content site where Outbrain recommendations appeared. |
dimension |
publisherId |
publisherId |
The unique identifier of the publisher. |
dimension |
publisherName |
publisherName |
The name of the publisher. |
dimension |
publisherUrl |
publisherUrl |
The URL of the publisher’s site. |
dimension |
publisher_name |
publisher_name |
The name of the publisher where the promoted content appeared. |
dimension |
qualityRead.averageValue |
qualityRead.averageValue |
The average amount of money reported for conversions from clicks specifically for the ‘qualityRead’ conversion pixel. |
metric |
qualityRead.conversionRate |
qualityRead.conversionRate |
The average rate of conversions from clicks per click percentage specifically for the ‘qualityRead’ conversion pixel. |
metric |
qualityRead.conversions |
qualityRead.conversions |
The total number of conversions from clicks specifically for the ‘qualityRead’ conversion pixel. |
metric |
qualityRead.cpa |
qualityRead.cpa |
The average Cost Per Acquisition (CPA) calculated for conversions from clicks specifically for the ‘qualityRead’ conversion pixel. |
metric |
qualityRead.sumValue |
qualityRead.sumValue |
The total amount of money reported for conversions from clicks specifically for the ‘qualityRead’ conversion pixel. |
metric |
qualityRead.totalAverageValue |
qualityRead.totalAverageValue |
The average amount of money reported for all conversions (clicks or views) specifically for the ‘qualityRead’ conversion pixel. |
metric |
qualityRead.totalConversions |
qualityRead.totalConversions |
The total number of conversions (clicks or views) specifically for the ‘qualityRead’ conversion pixel. |
metric |
qualityRead.totalCpa |
qualityRead.totalCpa |
The average Cost Per Acquisition (CPA) calculated for all conversions (clicks or views) specifically for the ‘qualityRead’ conversion pixel. |
metric |
qualityRead.totalSumValue |
qualityRead.totalSumValue |
The total amount of money reported for all conversions (clicks or views) specifically for the ‘qualityRead’ conversion pixel. |
metric |
qualityRead.viewAverageValue |
qualityRead.viewAverageValue |
The average amount of money reported for view-through conversions specifically for the ‘qualityRead’ conversion pixel. |
metric |
qualityRead.viewConversionRate |
qualityRead.viewConversionRate |
The average rate of view-through conversions per viewable impression percentage specifically for the ‘qualityRead’ conversion pixel. |
metric |
qualityRead.viewConversions |
qualityRead.viewConversions |
The total number of view-through conversions specifically for the ‘qualityRead’ conversion pixel. |
metric |
qualityRead.viewSumValue |
qualityRead.viewSumValue |
The total amount of money reported for view-through conversions specifically for the ‘qualityRead’ conversion pixel. |
metric |
qualityVisit30.averageValue |
qualityVisit30.averageValue |
The average amount of money reported for conversions from clicks specifically for the ‘qualityVisit30’ conversion pixel. |
metric |
qualityVisit30.conversionRate |
qualityVisit30.conversionRate |
The average rate of conversions from clicks per click percentage specifically for the ‘qualityVisit30’ conversion pixel. |
metric |
qualityVisit30.conversions |
qualityVisit30.conversions |
The total number of conversions from clicks specifically for the ‘qualityVisit30’ conversion pixel. |
metric |
qualityVisit30.cpa |
qualityVisit30.cpa |
The average Cost Per Acquisition (CPA) calculated for conversions from clicks specifically for the ‘qualityVisit30’ conversion pixel. |
metric |
qualityVisit30.sumValue |
qualityVisit30.sumValue |
The total amount of money reported for conversions from clicks specifically for the ‘qualityVisit30’ conversion pixel. |
metric |
qualityVisit30.totalAverageValue |
qualityVisit30.totalAverageValue |
The average amount of money reported for all conversions (clicks or views) specifically for the ‘qualityVisit30’ conversion pixel. |
metric |
qualityVisit30.totalConversions |
qualityVisit30.totalConversions |
The total number of conversions (clicks or views) specifically for the ‘qualityVisit30’ conversion pixel. |
metric |
qualityVisit30.totalCpa |
qualityVisit30.totalCpa |
The average Cost Per Acquisition (CPA) calculated for all conversions (clicks or views) specifically for the ‘qualityVisit30’ conversion pixel. |
metric |
qualityVisit30.totalSumValue |
qualityVisit30.totalSumValue |
The total amount of money reported for all conversions (clicks or views) specifically for the ‘qualityVisit30’ conversion pixel. |
metric |
qualityVisit30.viewAverageValue |
qualityVisit30.viewAverageValue |
The average amount of money reported for view-through conversions specifically for the ‘qualityVisit30’ conversion pixel. |
metric |
qualityVisit30.viewConversionRate |
qualityVisit30.viewConversionRate |
The average rate of view-through conversions per viewable impression percentage specifically for the ‘qualityVisit30’ conversion pixel. |
metric |
qualityVisit30.viewConversions |
qualityVisit30.viewConversions |
The total number of view-through conversions specifically for the ‘qualityVisit30’ conversion pixel. |
metric |
qualityVisit30.viewSumValue |
qualityVisit30.viewSumValue |
The total amount of money reported for view-through conversions specifically for the ‘qualityVisit30’ conversion pixel. |
metric |
qualityVisit45.averageValue |
qualityVisit45.averageValue |
The average amount of money reported for conversions from clicks specifically for the ‘qualityVisit45’ conversion pixel. |
metric |
qualityVisit45.conversionRate |
qualityVisit45.conversionRate |
The average rate of conversions from clicks per click percentage specifically for the ‘qualityVisit45’ conversion pixel. |
metric |
qualityVisit45.conversions |
qualityVisit45.conversions |
The total number of conversions from clicks specifically for the ‘qualityVisit45’ conversion pixel. |
metric |
qualityVisit45.cpa |
qualityVisit45.cpa |
The average Cost Per Acquisition (CPA) calculated for conversions from clicks specifically for the ‘qualityVisit45’ conversion pixel. |
metric |
qualityVisit45.sumValue |
qualityVisit45.sumValue |
The total amount of money reported for conversions from clicks specifically for the ‘qualityVisit45’ conversion pixel. |
metric |
qualityVisit45.totalAverageValue |
qualityVisit45.totalAverageValue |
The average amount of money reported for all conversions (clicks or views) specifically for the ‘qualityVisit45’ conversion pixel. |
metric |
qualityVisit45.totalConversions |
qualityVisit45.totalConversions |
The total number of conversions (clicks or views) specifically for the ‘qualityVisit45’ conversion pixel. |
metric |
qualityVisit45.totalCpa |
qualityVisit45.totalCpa |
The average Cost Per Acquisition (CPA) calculated for all conversions (clicks or views) specifically for the ‘qualityVisit45’ conversion pixel. |
metric |
qualityVisit45.totalSumValue |
qualityVisit45.totalSumValue |
The total amount of money reported for all conversions (clicks or views) specifically for the ‘qualityVisit45’ conversion pixel. |
metric |
qualityVisit45.viewAverageValue |
qualityVisit45.viewAverageValue |
The average amount of money reported for view-through conversions specifically for the ‘qualityVisit45’ conversion pixel. |
metric |
qualityVisit45.viewConversionRate |
qualityVisit45.viewConversionRate |
The average rate of view-through conversions per viewable impression percentage specifically for the ‘qualityVisit45’ conversion pixel. |
metric |
qualityVisit45.viewConversions |
qualityVisit45.viewConversions |
The total number of view-through conversions specifically for the ‘qualityVisit45’ conversion pixel. |
metric |
qualityVisit45.viewSumValue |
qualityVisit45.viewSumValue |
The total amount of money reported for view-through conversions specifically for the ‘qualityVisit45’ conversion pixel. |
metric |
roas |
roas |
Return On Ad Spend (ROAS) calculated as total conversion value attributed to clicks, divided by spend. |
metric |
scrollDepthSettingValue |
scrollDepthSettingValue |
For SCROLL_DEPTH engagement conversions, this is the percentage of scroll a user performs on a page that triggers the conversion. |
metric |
sectionId |
sectionId |
The unique identifier of the section within a publisher’s site. |
dimension |
sectionName |
promotedLinkSectionName |
The name of the section of the site where the PromotedLink URL points to. |
dimension |
sectionUrl |
sectionUrl |
The URL of the publisher’s specific content section where the promoted content was displayed. While not a direct API field, it can be derived from existing sectionName and publisherUrl attributes in performance reports. |
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 |
standardPurchase.averageValue |
standardPurchase.averageValue |
The average amount of money reported for conversions from clicks specifically for the ‘standardPurchase’ conversion pixel. |
metric |
standardPurchase.conversionRate |
standardPurchase.conversionRate |
The average rate of conversions from clicks per click percentage specifically for the ‘standardPurchase’ conversion pixel. |
metric |
standardPurchase.conversions |
standardPurchase.conversions |
The total number of conversions from clicks specifically for the ‘standardPurchase’ conversion pixel. |
metric |
standardPurchase.cpa |
standardPurchase.cpa |
The average Cost Per Acquisition (CPA) calculated for conversions from clicks specifically for the ‘standardPurchase’ conversion pixel. |
metric |
standardPurchase.sumValue |
standardPurchase.sumValue |
The total amount of money reported for conversions from clicks specifically for the ‘standardPurchase’ conversion pixel. |
metric |
standardPurchase.totalAverageValue |
standardPurchase.totalAverageValue |
The average amount of money reported for all conversions (clicks or views) specifically for the ‘standardPurchase’ conversion pixel. |
metric |
standardPurchase.totalConversions |
standardPurchase.totalConversions |
The total number of conversions (clicks or views) specifically for the ‘standardPurchase’ conversion pixel. |
metric |
standardPurchase.totalCpa |
standardPurchase.totalCpa |
The average Cost Per Acquisition (CPA) calculated for all conversions (clicks or views) specifically for the ‘standardPurchase’ conversion pixel. |
metric |
standardPurchase.totalSumValue |
standardPurchase.totalSumValue |
The total amount of money reported for all conversions (clicks or views) specifically for the ‘standardPurchase’ conversion pixel. |
metric |
standardPurchase.viewAverageValue |
standardPurchase.viewAverageValue |
The average amount of money reported for view-through conversions specifically for the ‘standardPurchase’ conversion pixel. |
metric |
standardPurchase.viewConversionRate |
standardPurchase.viewConversionRate |
The average rate of view-through conversions per viewable impression percentage specifically for the ‘standardPurchase’ conversion pixel. |
metric |
standardPurchase.viewConversions |
standardPurchase.viewConversions |
The total number of view-through conversions specifically for the ‘standardPurchase’ conversion pixel. |
metric |
standardPurchase.viewSumValue |
standardPurchase.viewSumValue |
The total amount of money reported for view-through conversions specifically for the ‘standardPurchase’ conversion pixel. |
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 |
targeting |
targeting |
An object containing various targeting settings for a campaign, such as platform, geo-location, language, and audience. |
dimension |
targetingStatus |
targetingStatus |
The targeting status of the interest, indicating whether it’s targeted, excluded, not targeted, partially targeted, or partially excluded. |
dimension |
text |
promotedLinkText |
The text or headline of the promoted link. |
dimension |
timeOnPageSettingValue |
timeOnPageSettingValue |
For TIME_ON_PAGE engagement conversions, this is the number of seconds a user stays on a page that triggers the conversion. |
metric |
title |
title |
The headline text of the promoted content (PromotedLink) or the name of a PromotedLinkSequence. |
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 |
trialPurchase.averageValue |
trialPurchase.averageValue |
The average amount of money reported for conversions from clicks specifically for the ‘trialPurchase’ conversion pixel. |
metric |
trialPurchase.conversionRate |
trialPurchase.conversionRate |
The average rate of conversions from clicks per click percentage specifically for the ‘trialPurchase’ conversion pixel. |
metric |
trialPurchase.conversions |
trialPurchase.conversions |
The total number of conversions from clicks specifically for the ‘trialPurchase’ conversion pixel. |
metric |
trialPurchase.cpa |
trialPurchase.cpa |
The average Cost Per Acquisition (CPA) calculated for conversions from clicks specifically for the ‘trialPurchase’ conversion pixel. |
metric |
trialPurchase.sumValue |
trialPurchase.sumValue |
The total amount of money reported for conversions from clicks specifically for the ‘trialPurchase’ conversion pixel. |
metric |
trialPurchase.totalAverageValue |
trialPurchase.totalAverageValue |
The average amount of money reported for all conversions (clicks or views) specifically for the ‘trialPurchase’ conversion pixel. |
metric |
trialPurchase.totalConversions |
trialPurchase.totalConversions |
The total number of conversions (clicks or views) specifically for the ‘trialPurchase’ conversion pixel. |
metric |
trialPurchase.totalCpa |
trialPurchase.totalCpa |
The average Cost Per Acquisition (CPA) calculated for all conversions (clicks or views) specifically for the ‘trialPurchase’ conversion pixel. |
metric |
trialPurchase.totalSumValue |
trialPurchase.totalSumValue |
The total amount of money reported for all conversions (clicks or views) specifically for the ‘trialPurchase’ conversion pixel. |
metric |
trialPurchase.viewAverageValue |
trialPurchase.viewAverageValue |
The average amount of money reported for view-through conversions specifically for the ‘trialPurchase’ conversion pixel. |
metric |
trialPurchase.viewConversionRate |
trialPurchase.viewConversionRate |
The average rate of view-through conversions per viewable impression percentage specifically for the ‘trialPurchase’ conversion pixel. |
metric |
trialPurchase.viewConversions |
trialPurchase.viewConversions |
The total number of view-through conversions specifically for the ‘trialPurchase’ conversion pixel. |
metric |
trialPurchase.viewSumValue |
trialPurchase.viewSumValue |
The total amount of money reported for view-through conversions specifically for the ‘trialPurchase’ conversion pixel. |
metric |
type |
type |
A categorization field indicating the specific type of an entity or event, such as budget type, conversion event type, or campaign content type. |
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 |