Sponsored Ads

Metric	Value
Frequency Of Download	Daily
Date Range Of Download	Last 30 Days
Historical Date Range For A New Account	Last 30 Days

Balance

Table name - ad_balance

Column Name	Data type	Description
account_id	Integer	Intentwise account id
account_name	String	Intentwise account name
currency_code	String	One single currency for billing, budgeting, bid settings & campaign performance metrics
country_code	String	Countries associated with the account
balance_id	String	Balance ID
created_at	Timestamp	Timestamp in UTC of balance creation
deposited	Numeric	Amount of funds deposited, uncapped
end_date	Date	Balance end date in the account timeZone; available indefinitely if null
memo	String	Memo
balance_name	String	Balance Name
po_number	String	Purchase order number
remaining	Numeric	Amount of funds remaining until cap is hit, null if not set
spent	Numeric	Amount of funds already spent
start_date	Date	Balance start date in the account
status	String	Balance status
updated_at	Timestamp	Timestamp in UTC of last balance update

Brand

Table - ad_brand

Column Name	Data type	Description
account_id	Integer	Intentwise account id
account_name	String	Intentwise account name
currency_code	String	One single currency for billing, budgeting, bid settings & campaign performance metrics
country_code	String	Countries associated with the account
brand_id	String	Brand ID
name	String	Brand name

Campaign

Table : ad_campaign

Column Name	Data type	Description
account_id	Integer	Intentwise account id
account_name	String	Intentwise account name
currency_code	String	One single currency for billing, budgeting, bid settings & campaign performance metrics
country_code	String	Countries associated with the account
campaign_id	String	Campaign ID
budget	Numeric	Campaign lifetime spend cap; uncapped if omitted or set to null
budget_remaining	Numeric	Amount the campaign has remaining until cap is hit; null if budget is uncapped
budget_spent	Numeric	Amount the campaign has already spent
click_attribution_window	String	Post-click attribution window
click_attribution_scope	String	Post-click attribution scope
created_at	Timestamp	Timestamp in UTC of campaign creation
drawable_balance_ids	String	List of balances the campaign is able to draw from; at least one balance is required for a campaign to begin
name	String	Campaign name; must be unique within an account
promoted_brand_ids	String	Set of brands represented in line items of the campaign; note this set is append only
status	String	Campaign status, derived from the status of line items it holds; active if at least one line item is active
type	String	Campaign type
updated_at	Timestamp	Timestamp in UTC of last campaign update
view_attribution_window	String	Post-view attribution window
view_attribution_scope	String	Post-view attribution scope
version	Integer	Version

Campaign Line Item Keyword

Table : ad_campaign_line_item_keyword_report

Column Name	Data type	Description
account_id	Integer	Intentwise account id
account_name	String	Intentwise account name
report_date	Date	Report Generated Date
keyword	String	Keyword or phrase used to land on the search page where an ad creative rendered
line_item_id	String	Line item ID of the requested report
attributed_orders	Integer	Orders (or transactions) attributed to a click or impression
attributed_sales	Numeric	Sales revenue attributed to a click or impression; exclusive of assistedSales
attributed_units	Integer	Units sold attributed to a click or impression; exclusive of assistedUnits
clicks	Integer	Measured when an ad creative is clicked on, which incurs a cost to the advertiser for open auction campaigns
cpc	Numeric	Cost-per-click (CPC), calculated by dividing spend by clicks; inclusive of platform fees
cpo	Numeric	Cost-per-order (CPO), calculated by dividing spend by attributedOrders; inclusive of platform fees
roas	Numeric	Return-on-ad-spend (ROAS), calculated by dividing attributedSales by spend; inclusive of platform fees
spend	Numeric	For open auctions campaigns, the total cost of clicks for the advertiser; inclusive of platform fees
assisted_sales	Numeric	Sales revenue attributed to a click or impression on the path to purchase leading to the sale; exclusive of attributedSales
assisted_units	Integer	Units sold attributed to a click or impression on the path to purchase leading to the sale; attributedUnits
campaign_id	String	Campaign ID
line_item_ctr	Numeric	Click-through-rate (CTR), calculated by dividing clicks by productImpressions for Product and Product Category report types; for all other report types, the appropriate placementImpressions is used instead
line_item_placement_impressions	Integer	Measured when an ad creative renders on a page; an ad creative may display products from one or more line items; each unique line item is counted once; used in all report types except for Product and Product Category reports
retailer_id	Integer	Retailer ID of the retailer the line item served on
retailer_name	String	Retailer name of the retailer the line item served on

Campaign Line Item Page Type

Table - ad_campaign_line_item_page_type_report

Column Name	Data type	Description
account_id	Integer	Intentwise account id
account_name	String	Intentwise account name
report_date	Date	Report Generated Date
line_item_id	String	Line item ID of the requested report
page_type_name	String	Type of retailer web page an ad creative rendered on, such as home page, browse pages, search pages, product detail pages, checkout pages etc.
attributed_orders	Integer	Orders (or transactions) attributed to a click or impression
attributed_sales	Numeric	Sales revenue attributed to a click or impression; exclusive of assistedSales
attributed_units	Integer	Units sold attributed to a click or impression; exclusive of assistedUnits
clicks	Integer	Measured when an ad creative is clicked on, which incurs a cost to the advertiser for open auction campaigns
cpc	Numeric	Cost-per-click (CPC), calculated by dividing spend by clicks; inclusive of platform fees
cpo	Numeric	Cost-per-order (CPO), calculated by dividing spend by attributedOrders; inclusive of platform fees
roas	Numeric	Return-on-ad-spend (ROAS), calculated by dividing attributedSales by spend; inclusive of platform fees
spend	Numeric	For open auctions campaigns, the total cost of clicks for the advertiser; inclusive of platform fees
assisted_sales	Numeric	Sales revenue attributed to a click or impression on the path to purchase leading to the sale; exclusive of attributedSales
assisted_units	Integer	Units sold attributed to a click or impression on the path to purchase leading to the sale; attributedUnits
campaign_id	String	Campaign ID
line_item_ctr	Numeric	Click-through-rate (CTR), calculated by dividing clicks by productImpressions for Product and Product Category report types; for all other report types, the appropriate placementImpressions is used instead
line_item_placement_impressions	Integer	Measured when an ad creative renders on a page; an ad creative may display products from one or more line items; each unique line item is counted once; used in all report types except for Product and Product Category reports
retailer_id	Integer	Retailer ID of the retailer the line item served on
retailer_name	String	Retailer name of the retailer the line item served on

Campaign Line Item Product Category

Table - ad_campaign_line_item_product_category_report

Column Name	Data type	Description
account_id	Integer	Intentwise account id
account_name	String	Intentwise account name
report_date	date	Report Generated Date
line_item_id	String	Line item ID of the requested report
adv_product_category	String	Category of product advertised; categories are standardized across brands and retailers, which may differ from retailer-specific categories
attributed_orders	Integer	Orders (or transactions) attributed to a click or impression
attributed_sales	Numeric	Sales revenue attributed to a click or impression; exclusive of assistedSales
attributed_units	Integer	Units sold attributed to a click or impression; exclusive of assistedUnits
click_spend	Numeric	Spend by clicks
product_clicks	Integer	Measured when an ad creative is clicked on, which incurs a cost to the advertiser for open auction campaigns
product_cpc	Numeric	Cost-per-click (CPC), calculated by dividing spend by clicks; inclusive of platform fees
product_cpo	Numeric	Cost-per-order (CPO), calculated by dividing spend by attributedOrders; inclusive of platform fees
product_ctr	Numeric	Click-through-rate (CTR), calculated by dividing clicks by productImpressions for Product and Product Category report types; for all other report types, the appropriate placementImpressions is used instead
product_impressions	Integer	Measured when a promoted product is rendered on the page, whether as a single ad creative or as one of many products in an ad creative; each product is counted once separately
product_roas	Numeric	Return-on-ad-spend (ROAS), calculated by dividing attributedSales by spend; inclusive of platform fees
assisted_sales	Numeric	Sales revenue attributed to a click or impression on the path to purchase leading to the sale; exclusive of attributedSales
assisted_units	Integer	Units sold attributed to a click or impression on the path to purchase leading to the sale; attributedUnits
campaign_id	String	Campaign ID
retailer_id	Integer	Retailer ID of the retailer the line item served on
retailer_name	String	Retailer name of the retailer the line item served on

Campaign Line Item Product Category

Table - ad_campaign_line_item_product_report

Column Name	Data type	Description
account_id	Integer	Intentwise account id
account_name	String	Intentwise account name
adv_product_id	String	Advertised product ID; this references the same ID used in Catalogs
report_date	Date	Report Generated Date
line_item_id	String	Line item ID of the requested report
adv_product_category	String	Category of product advertised; categories are standardized across brands and retailers, which may differ from retailer-specific categories
attributed_orders	Integer	Orders (or transactions) attributed to a click or impression
attributed_sales	Numeric	Sales revenue attributed to a click or impression; exclusive of assistedSales
attributed_units	Integer	Units sold attributed to a click or impression; exclusive of assistedUnits
click_spend	Numeric	Spend by clicks
product_clicks	Integer	Measured when an ad creative is clicked on, which incurs a cost to the advertiser for open auction campaigns
product_cpc	Numeric	Cost-per-click (CPC), calculated by dividing spend by clicks; inclusive of platform fees
product_cpo	Numeric	Cost-per-order (CPO), calculated by dividing spend by attributedOrders; inclusive of platform fees
product_ctr	Numeric	Click-through-rate (CTR), calculated by dividing clicks by productImpressions for Product and Product Category report types; for all other report types, the appropriate placementImpressions is used instead
product_impressions	Integer	Measured when a promoted product is rendered on the page, whether as a single ad creative or as one of many products in an ad creative; each product is counted once separately
product_roas	Numeric	Return-on-ad-spend (ROAS), calculated by dividing attributedSales by spend; inclusive of platform fees
adv_product_name	String	Advertised product name
assisted_sales	Numeric	Sales revenue attributed to a click or impression on the path to purchase leading to the sale; exclusive of attributedSales
assisted_units	Integer	Units sold attributed to a click or impression on the path to purchase leading to the sale; attributedUnits
brand_id	String	Advertised product brand ID
brand_name	String	Advertised product brand name; names are standardized across retailers
campaign_id	String	Campaign ID
retailer_id	Integer	Retailer ID of the retailer the line item served on
retailer_name	String	Retailer name of the retailer the line item served on

Campaign Line Item Summary

Table - ad_campaign_line_item_summary_report

Column Name	Data type	Description
account_id	Integer	Intentwise account id
account_name	String	Intentwise account name
report_date	Date	Report Generated Date
line_item_id	String	Line item ID of the requested report
attributed_orders	Integer	Orders (or transactions) attributed to a click or impression
attributed_sales	Numeric	Sales revenue attributed to a click or impression; exclusive of assistedSales
attributed_units	Integer	Units sold attributed to a click or impression; exclusive of assistedUnits
clicks	Integer	Spend by clicks
cpc	Numeric	Cost-per-click (CPC), calculated by dividing spend by clicks; inclusive of platform fees
cpo	Numeric	Cost-per-order (CPO), calculated by dividing spend by attributedOrders; inclusive of platform fees
roas	Numeric	Click-through-rate (CTR), calculated by dividing clicks by productImpressions for Product and Product Category report types; for all other report types, the appropriate placementImpressions is used instead
spend	Numeric	For open auctions campaigns, the total cost of clicks for the advertiser; inclusive of platform fees
assisted_sales	Numeric	Sales revenue attributed to a click or impression on the path to purchase leading to the sale; exclusive of attributedSales
assisted_units	Integer	Units sold attributed to a click or impression on the path to purchase leading to the sale; attributedUnits
campaign_id	String	Campaign ID
frequency	Numeric	An average representing how often an impression has painted for the same user
line_item_ctr	Numeric	Click-through-rate (CTR), calculated by dividing clicks by productImpressions for Product and Product Category report types; for all other report types, the appropriate placementImpressions is used instead
line_item_placement_impressions	Integer	Measured when an ad creative renders on a page; an ad creative may display products from one or more line items; each unique line item is counted once; used in all report types except for Product and Product Category reports
retailer_id	Integer	Retailer ID of the retailer the line item served on
retailer_name	String	Retailer name of the retailer the line item served on
unique_visitors	Integer	Number of unique visitors an impression painted for

Campaign Page Type

Table - ad_campaign_page_type_report

Column Name	Data type	Description
account_id	Integer	Intentwise account id
account_name	String	Intentwise account name
campaign_id	String	Campaign ID
report_date	Date	Report Generated Date
page_type_name	String	Type of retailer web page an ad creative rendered on, such as home page, browse pages, search pages, product detail pages, checkout pages etc.
attributed_orders	Integer	Orders (or transactions) attributed to a click or impression
attributed_sales	Numeric	Sales revenue attributed to a click or impression; exclusive of assistedSales
attributed_units	Integer	Units sold attributed to a click or impression; exclusive of assistedUnits
clicks	Integer	Measured when an ad creative is clicked on, which incurs a cost to the advertiser for open auction campaigns
cpc	Numeric	Cost-per-click (CPC), calculated by dividing spend by clicks; inclusive of platform fees
cpo	Numeric	Cost-per-order (CPO), calculated by dividing spend by attributedOrders; inclusive of platform fees
roas	Numeric	Return-on-ad-spend (ROAS), calculated by dividing attributedSales by spend; inclusive of platform fees
spend	Numeric	For open auctions campaigns, the total cost of clicks for the advertiser; inclusive of platform fees
campaign_ctr	Numeric	Click-through-rate (CTR), calculated by dividing clicks by productImpressions for Product and Product Category report types; for all other report types, the appropriate placementImpressions is used instead
campaign_placement_impressions	Integer	Measured when an ad creative renders on a page; an ad creative may display products from one or more campaigns; each unique campaign is counted once; used in all report types except for Product and Product Category reports
campaign_type_name	String	Type of campaign configured

Campaign Product Category

Table - ad_campaign_product_category_report

Column Name	Data type	Description
account_id	Integer	Intentwise account id
account_name	String	Intentwise account name
campaign_id	String	Campaign ID
report_date	Date	Report Generated Date
adv_product_category	String	Category of product advertised; categories are standardized across brands and retailers, which may differ from retailer-specific categories
attributed_orders	Integer	Orders (or transactions) attributed to a click or impression
attributed_sales	Numeric	Sales revenue attributed to a click or impression; exclusive of assistedSales
attributed_units	Integer	Units sold attributed to a click or impression; exclusive of assistedUnits
click_spend	Numeric	Measured when an ad creative is clicked on, which incurs a cost to the advertiser for open auction campaigns
product_clicks	Integer	Measured when an ad creative is clicked on, which incurs a cost to the advertiser for open auction campaigns
product_cpc	Numeric	Cost-per-click (CPC), calculated by dividing spend by clicks; inclusive of platform fees
product_cpo	Numeric	Cost-per-order (CPO), calculated by dividing spend by attributedOrders; inclusive of platform fees
product_ctr	Numeric	Click-through-rate (CTR), calculated by dividing clicks by productImpressions for Product and Product Category report types; for all other report types, the appropriate placementImpressions is used instead
product_impressions	Integer	Measured when a promoted product is rendered on the page, whether as a single ad creative or as one of many products in an ad creative; each product is counted once separately
product_roas	Numeric	Return-on-ad-spend (ROAS), calculated by dividing attributedSales by spend; inclusive of platform fees
campaign_type_name	String	Type of campaign configured

Campaign Product

Table - ad_campaign_product_report

Column Name	Data type	Description
account_id	Integer	Intentwise account id
account_name	String	Intentwise account name
adv_product_id	String	Advertised product ID; this references the same ID used in Catalogs
campaign_id	String	Campaign ID
report_date	Date	Report Generated Date
adv_product_category	String	Category of product advertised; categories are standardized across brands and retailers, which may differ from retailer-specific categories
attributed_orders	Integer	Orders (or transactions) attributed to a click or impression
attributed_sales	Numeric	Sales revenue attributed to a click or impression; exclusive of assistedSales
attributed_units	Integer	Units sold attributed to a click or impression; exclusive of assistedUnits
click_spend	Numeric	Measured when an ad creative is clicked on, which incurs a cost to the advertiser for open auction campaigns
product_clicks	Integer	Measured when an ad creative is clicked on, which incurs a cost to the advertiser for open auction campaigns
product_cpc	Numeric	Cost-per-click (CPC), calculated by dividing spend by clicks; inclusive of platform fees
product_cpo	Numeric	Cost-per-order (CPO), calculated by dividing spend by attributedOrders; inclusive of platform fees
product_ctr	Numeric	Click-through-rate (CTR), calculated by dividing clicks by productImpressions for Product and Product Category report types; for all other report types, the appropriate placementImpressions is used instead
product_impressions	Integer	Measured when a promoted product is rendered on the page, whether as a single ad creative or as one of many products in an ad creative; each product is counted once separately
product_roas	Numeric	Return-on-ad-spend (ROAS), calculated by dividing attributedSales by spend; inclusive of platform fees
adv_product_name	String	Advertised product name
brand_id	String	Advertised product brand ID
brand_name	String	Advertised product brand name; names are standardized across retailers
campaign_type_name	String	Type of campaign configured

Campaign Summary

Table - ad_campaign_summary_report

Column Name	Data type	Description
account_id	Integer	Intentwise account id
account_name	String	Intentwise account name
campaign_id	String	Campaign ID
report_date	Date	Report Generated Date
attributed_orders	Integer	Orders (or transactions) attributed to a click or impression
attributed_sales	Numeric	Sales revenue attributed to a click or impression; exclusive of assistedSales
attributed_units	Integer	Units sold attributed to a click or impression; exclusive of assistedUnits
clicks	Integer	Measured when an ad creative is clicked on, which incurs a cost to the advertiser for open auction campaigns
cpc	Numeric	Measured when an ad creative is clicked on, which incurs a cost to the advertiser for open auction campaigns
cpo	Numeric	Cost-per-click (CPC), calculated by dividing spend by clicks; inclusive of platform fees
roas	Numeric	Cost-per-order (CPO), calculated by dividing spend by attributedOrders; inclusive of platform fees
spend	Numeric	For open auctions campaigns, the total cost of clicks for the advertiser; inclusive of platform fees
campaign_ctr	Numeric	Click-through-rate (CTR), calculated by dividing clicks by productImpressions for Product and Product Category report types; for all other report types, the appropriate placementImpressions is used instead
campaign_placement_impressions	Integer	Measured when an ad creative renders on a page; an ad creative may display products from one or more campaigns; each unique campaign is counted once; used in all report types except for Product and Product Category reports
campaign_type_name	String	Type of campaign configured
frequency	Numeric	An average representing how often an impression has painted for the same user
unique_visitors	Integer	Number of unique visitors an impression painted for

CampaignKeyword

Table - ad_campaignkeyword_report

Column Name	Data type	Description
account_id	Integer	Intentwise account id
account_name	String	Intentwise account name
currency_code	String	One single currency for billing, budgeting, bid settings & campaign performance metrics
country_code	String	Countries associated with the account
campaign_id	String	Campaign ID
report_date	Date	Report Generated Date
keyword	String	Keyword or phrase used to land on the search page where an ad creative rendered
attributed_orders	Integer	Orders (or transactions) attributed to a click or impression
attributed_sales	Numeric	Sales revenue attributed to a click or impression; exclusive of assistedSales
attributed_units	Integer	Units sold attributed to a click or impression; exclusive of assistedUnits
clicks	Integer	Measured when an ad creative is clicked on, which incurs a cost to the advertiser for open auction campaigns
cpc	Numeric	Measured when an ad creative is clicked on, which incurs a cost to the advertiser for open auction campaigns
cpo	Numeric	Cost-per-click (CPC), calculated by dividing spend by clicks; inclusive of platform fees
roas	Numeric	Cost-per-order (CPO), calculated by dividing spend by attributedOrders; inclusive of platform fees
spend	Numeric	For open auctions campaigns, the total cost of clicks for the advertiser; inclusive of platform fees
campaign_ctr	Numeric	Click-through-rate (CTR), calculated by dividing clicks by productImpressions for Product and Product Category report types; for all other report types, the appropriate placementImpressions is used instead
campaign_placement_impressions	Integer	Measured when an ad creative renders on a page; an ad creative may display products from one or more campaigns; each unique campaign is counted once; used in all report types except for Product and Product Category reports
campaign_type_name	String	Type of campaign configured

Line Item

Table - ad_line_item

Column Name	Data type	Description
account_id	Integer	Intentwise account id
account_name	String	Intentwise account name
currency_code	String	One single currency for billing, budgeting, bid settings & campaign performance metrics
country_code	String	Countries associated with the account
line_item_id	String	Line item ID of the requested report
budget	Numeric	Campaign lifetime spend cap; uncapped if omitted or set to null
budget_remaining	Numeric	Amount the campaign has remaining until cap is hit; null if budget is uncapped
budget_spent	Numeric	Amount the campaign has already spent
campaign_id	String	Campaign ID
created_at	Timestamp	Timestamp in UTC of balance creation
end_date	Date	Balance end date in the account timeZone; available indefinitely if null
name	String	Brand name
start_date	date	Balance start date in the account
status	String	Balance status
target_retailer_id	String	Retailer ID of the retailer the line item served on retailerName
type	String	Campaign type
updated_at	Timestamp	Timestamp in UTC of last balance update
max_bid	Numeric	The maximum amount allowed to bid for each bid; respected regardless of targetBid;
monthly_pacing	Numeric	Amount the line item can spend per calendar month in the account timeZone;
daily_pacing	Numeric	Amount the line item can spend per day in the account timeZone;
bid_strategy	String	Bid algorithm optimizing for sales conversions, sales revenue, or clicks
target_bid	Numeric	A target average amount to bid because each bid is modulated up or down by our optimization algorithm;
auto_daily_pacing	Boolean	To activate, either line item endDate and budget, or monthlyPace, must be specified; overwrites dailyPacing with a calculation if not set prior
version	Integer	Version

Line Item Keyword

Table - ad_line_item_product

Column Name	Data type	Description
account_id	Integer	Intentwise account id
account_name	String	Intentwise account name
currency_code	String	One single currency for billing, budgeting, bid settings & campaign performance metrics
country_code	String	Countries associated with the account
line_item_id	String	Line item ID of the requested report
product_id	String	Advertised product ID; this references the same ID used in Catalogs
bid_override	Numeric	Amount used to bid for the specific product; overrides targetBid specified on the line item and behaves similarly; must meet minBid, which is retrieved through the catalogs; input excludes platform fees
type	String	Campaign type
version	Integer	Version

Product Catelog

Table - ad_product_catalog

Column Name	Data type	Description
account_id	Integer	Intentwise account id
account_name	String	Intentwise account name
currency_code	String	One single currency for billing, budgeting, bid settings & campaign performance metrics
country_code	String	Countries associated with the account
product_id	String	Advertised product ID; this references the same ID used in Catalogs
product_name	String	Advertised product name
category	String	Retailer product category
brand_id	String	Brand ID
brand_name	String	Brand name
retailer_id	String	Retailer ID of the retailer the line item served on
retailer_name	String	Retailer name of the retailer the line item served on
price	Numeric	Retailer product price in USD
is_in_stock	Boolean	Whether or not the product is in stock
min_bid	Numeric	Minimum Cost-Per-Click (CPC) an advertiser must bid for the product, established by the retailer; any line item with this product must have targetBid meet this value
gtin	String	Global Trade Item Number (GTIN), if available; also known as European Article Number (EAN) or Universal Product Code (UPC)
mpn	String	Manufacturer Part Number (MPN), if available
image_url	String	Retailer URL for the product image
updated_at	Timestamp	Timestamp in UTC of last update

Retailer

Table - ad_retailer

Column Name	Data type	Description
account_id	Integer	Intentwise account id
account_name	String	Intentwise account name
currency_code	String	One single currency for billing, budgeting, bid settings & campaign performance metrics
country_code	String	Countries associated with the account
retailer_id	String	Retailer ID of the retailer the line item served on
name	String	Retailer name of the retailer the line item served on