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

Conversions.averageValue

Conversions.averageValue

The average value generated per conversion event. This metric helps evaluate the efficiency of conversions.

metric

Conversions.conversionRate

Conversions.conversionRate

The rate at which ad engagements (e.g., clicks) lead to a conversion event. It is calculated as (Conversions / Clicks or Impressions) * 100%.

metric

Conversions.conversions

Conversions.conversions

The total number of conversion events recorded for a campaign or promoted content.

metric

Conversions.cpa

Conversions.cpa

The Cost Per Acquisition (CPA), which is the average cost incurred to achieve one conversion event.

metric

Conversions.roas

Conversions.roas

The Return On Ad Spend (ROAS), which indicates the revenue generated for every unit of currency spent on advertising.

metric

Conversions.sumValue

Conversions.sumValue

The sum of values for all recorded conversion events.

metric

Conversions.totalAverageValue

Conversions.totalAverageValue

The average value generated per conversion across all conversions tracked.

metric

Conversions.totalConversions

Conversions.totalConversions

The aggregate total number of all conversion events, often including different types of conversions or across various campaigns.

metric

Conversions.totalCpa

Conversions.totalCpa

The total cost per acquisition (CPA) for all conversions, calculated as the total spend divided by the total number of conversions. This metric helps evaluate the efficiency of campaigns in acquiring conversions.

metric

Conversions.totalRoas

Conversions.totalRoas

The total return on ad spend (ROAS) for all conversions, indicating the revenue generated for every unit of currency spent on advertising. This metric is crucial for assessing campaign profitability.

metric

Conversions.totalSumValue

Conversions.totalSumValue

The sum of values for all conversions recorded. This represents the total value attributed to successful conversion events.

metric

Conversions.viewAverageValue

Conversions.viewAverageValue

The average value generated per view-through conversion. View-through conversions occur when a user sees an ad but does not click on it, and later completes a conversion.

metric

Conversions.viewConversionRate

Conversions.viewConversionRate

The rate at which ad views lead to view-through conversions, calculated as the number of view-through conversions divided by the total number of ad impressions.

metric

Conversions.viewConversions

Conversions.viewConversions

The total number of view-through conversions. A view-through conversion is attributed to an ad impression (view) rather than a direct click.

metric

Conversions.viewSumValue

Conversions.viewSumValue

The sum of values for all view-through conversions recorded. This represents the total value attributed to conversions that occurred after an ad view.

metric

Date

Date

The date of the report or metric breakdown.

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

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.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.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

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.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.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

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

creationTime

creationTime

The time when the promoted link 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.

dimension

currency

currency

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

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

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

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

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

sumValue

sumValue

The total monetary amount reported for conversions from clicks.

metric

text

promotedLinkText

The text or headline of the promoted link.

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