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

Country

country

The country associated with geographic targeting or performance data.

dimension

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

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

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

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

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

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 alphanumeric code used to identify an entity or record within the Outbrain platform, such as a campaign ID, marketer ID, or conversion event ID.

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

lastModified

lastModified

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

A timestamp indicating when the data record was loaded into the data integration platform. This is an internal metadata field for tracking data ingestion.

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

text

promotedLinkText

The text or headline of the promoted link.

dimension

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

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

url

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