Bol.: Most-used fields

Bol.: Most-used fields#

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

acos

acos

Advertising Cost of Sales (ACoS), representing advertising spend as a percentage of sales generated from advertising.

dimension

acos14d

acos14d

The Advertising Cost of Sales (ACoS) calculated over a 14-day attribution window, reflecting advertising spend as a percentage of sales.

metric

adConstraints

adConstraints

dimension

adGroupId

adGroupId

A unique identifier for an ad group within a campaign.

metric

adGroupName

adGroupName

The name of the ad group.

dimension

adId

adId

A unique identifier for an individual ad.

metric

averageCpc

averageCpc

The average cost per click (CPC) for an ad, ad group, or campaign.

metric

averageWinningBid

averageWinningBid

The average bid amount that resulted in a won auction for an ad, keyword, or target.

metric

bidding.automaticBidDesiredAcosPercentage

bidding.automaticBidDesiredAcosPercentage

The desired ACoS (Advertising Cost of Sales) percentage set for automatic bidding strategies. This indicates the target advertising spend as a percentage of generated sales.

metric

bidding.defaultBid

bidding.defaultBid

The default bid amount set for an ad group or keyword, used when no specific bid is provided.

metric

bidding.strategy

bidding.strategy

The strategy chosen for advertising campaigns, such as automatic or manual bidding, to optimize ad spend and achieve performance goals.

dimension

brand

brand

The brand associated with the product being advertised or sold.

dimension

campaignEndDate

campaignEndDate

The date on which the campaign is scheduled to end.

dimension

campaignId

campaignId

A unique identifier for a campaign.

metric

campaignName

campaignName

The name of the campaign.

dimension

campaignStartDate

campaignStartDate

The date on which the campaign is scheduled to start.

dimension

campaignType

campaignType

The type of advertising campaign (e.g., MANUAL).

dimension

categoryId

categoryId

A unique identifier for a product category.

metric

categoryName

categoryName

The name of the product category.

dimension

categoryVolume

categoryVolume

The total search volume for a specific category, indicating its popularity and potential reach.

metric

clickShare

clickShare

The percentage of total available clicks an advertiser’s ads received for a specific search term, category, or product detail page placement.

metric

clicks

clicks

The number of clicks an ad or campaign received.

metric

conversionRate

conversionRate

The percentage of clicks that resulted in a conversion.

dimension

conversionRate14d

conversionRate14d

The conversion rate calculated over a 14-day attribution window.

metric

conversions

conversions

The total number of conversions attributed to an ad or campaign.

metric

conversions14d

conversions14d

The total number of conversions over a 14-day attribution window.

metric

cost

cost

The total advertising cost or spend.

metric

countries

countries

The country or countries where the ad campaign is active or targeted.

dimension

cpc

cpc

Cost per click, the amount paid for each click on an ad.

metric

ctr

ctr

Click-through rate (CTR), the percentage of impressions that resulted in a click.

metric

dailyBudget

dailyBudget

The maximum amount of money allocated for spending on a campaign or ad group per day.

metric

dailyBudgetAmount

dailyBudgetAmount

The numerical value of the daily budget.

metric

dailyBudgetCurrency

dailyBudgetCurrency

The currency in which the daily budget is set.

dimension

dailySpendAmount

dailySpendAmount

The numerical value of the amount spent on advertising for a given day.

metric

dailySpendCurrency

dailySpendCurrency

The currency in which the daily advertising spend is measured.

dimension

date

date

The specific date for which the performance metrics are reported.

dimension

defaultBid

defaultBid

The default bid amount set for an ad group or keyword, used when no specific bid is provided.

metric

directConversions14d

directConversions14d

The number of direct conversions (sales directly resulting from an ad click) over a 14-day attribution window.

metric

ean

ean

The European Article Number, a unique identifier for a product.

metric

endDate

endDate

The end date of the reporting period or campaign duration.

dimension

exportDate

exportDate

The date on which the data was exported or generated for a report or file. For example, it could indicate the creation date of an offer export file.

dimension

impressionShare

impressionShare

The percentage of total available impressions an advertiser’s ads received for a specific search term, category, product detail page placement, or overall.

metric

impressions

impressions

The total number of times an ad was displayed.

metric

indirectConversions14d

indirectConversions14d

The number of indirect conversions (sales influenced by, but not directly from, an ad click) over a 14-day attribution window.

metric

keywordConstraints

keywordConstraints

Rules or parameters that define how keywords are used in advertising campaigns, including match types (e.g., exact, phrase) and negative keywords.

dimension

keywordId

keywordId

A unique identifier for a keyword.

metric

keywordMatchType

keywordMatchType

The match type of the keyword (e.g., EXACT, PHRASE, BROAD).

dimension

keywordText

keywordText

The actual text of the keyword.

dimension

matchType

matchType

The type of match used for targeting, such as exact, phrase, or broad match for keywords.

dimension

name

name

The descriptive name associated with an entity, such as an ad campaign, product, label, or affiliate link.

dimension

productName

productName

The name of the product.

dimension

roas

roas

Return on Advertising Spend (ROAS), representing the revenue generated for every unit of advertising cost.

metric

roas14d

roas14d

The Return on Advertising Spend (ROAS) calculated over a 14-day attribution window.

metric

sales

sales

The total sales amount generated from advertising.

metric

sales14d

sales14d

The total sales generated over a 14-day attribution window.

metric

searchTerm

searchTerm

The actual search query entered by a user that triggered an ad.

dimension

searchVolume

searchVolume

The estimated number of times a specific search term was queried.

metric

spent

spent

The total amount of money spent on advertising.

metric

sponsoredConversions

sponsoredConversions

The total number of conversions attributed to sponsored products.

metric

sponsoredDirectConversions

sponsoredDirectConversions

The number of direct conversions specifically from sponsored products.

metric

sponsoredDirectSales

sponsoredDirectSales

The sales amount generated directly from sponsored products.

metric

sponsoredIndirectConversions

sponsoredIndirectConversions

The number of indirect conversions specifically from sponsored products.

metric

sponsoredIndirectSales

sponsoredIndirectSales

The sales amount generated indirectly from sponsored products.

metric

sponsoredSales

sponsoredSales

The total sales amount generated from sponsored products.

metric

startDate

startDate

The start date of the reporting period or campaign duration.

dimension

state

state

The current status or state of an entity, such as an advertising campaign, ad group, offer, or an asynchronous report generation process.

dimension

subcategories

subcategories

A hierarchical classification of products or listings, representing categories nested under a broader main category.

dimension

tacos

tacos

Total Advertising Cost of Sale (TACOS) is a key performance indicator that measures advertising spend relative to the total revenue generated, including both direct and indirect sales influenced by advertising.

dimension

targetCategoryId

targetCategoryId

A unique identifier for a category that is specifically targeted by an ad campaign.

metric

targetChannels

targetChannels

The advertising channels where products or campaigns are targeted and promoted, used for generating ad performance reports broken down by channel.

dimension

targetCountries

targetCountries

The countries specifically targeted by an ad campaign.

dimension

targetPage

targetPage

The type of page where sponsored products are shown (e.g., SEARCH for search results, CATEGORY for category browsing, PDP for product detail pages).

dimension

targetProductId

targetProductId

A unique identifier for a product that is specifically targeted by an ad campaign.

metric

targetingType

targetingType

The method used to focus advertising efforts on a specific audience or product group, such as automatic targeting (AI-driven) or manual targeting (keyword-based).

dimension

totalBudget

totalBudget

The maximum total amount of money allocated for spending throughout the entire duration of a campaign.

metric

totalBudgetAmount

totalBudgetAmount

The numerical value of the total budget.

metric

totalBudgetCurrency

totalBudgetCurrency

The currency in which the total budget is set.

dimension

totalClicks

totalClicks

The overall total number of clicks for a specific entity or period.

metric

totalConversions

totalConversions

The total number of all conversions (organic and sponsored).

metric

totalImpressions

totalImpressions

The overall total number of impressions for a specific entity or period.

metric

totalSales

totalSales

The total sales amount generated, including both organic and sponsored sales.

metric

totalSpendAmount

totalSpendAmount

The numerical value of the total amount spent on advertising.

metric

totalSpendCurrency

totalSpendCurrency

The currency in which the total advertising spend is measured.

dimension

url

url

A web address pointing to a resource, which could be a product page, an image, or a downloadable report file.

dimension