Amazon DSP Connector Reference

110 metrics49 dimensions

Fields Actions

The Amazon DSP connector exposes 159 fields (110 metrics, 49 dimensions). Every field ID below can be passed to the Windsor.ai API in the fields parameter.

Available actions

Create Campaign Create an Amazon DSP campaign with a single flight (start, end, budget), an uncapped frequency, and the given optimization goal. The campaign is created in an inactive state and only starts delivering after ad groups with creatives are added and the campaign is activated via the update_campaign action. The budget amount is in the advertiser currency major unit (e.g. 100.00 means one hundred).

Create an Amazon DSP campaign with a single flight (start, end, budget), an uncapped frequency, and the given optimization goal. The campaign is created in an inactive state and only starts delivering after ad groups with creatives are added and the campaign is activated via the update_campaign action. The budget amount is in the advertiser currency major unit (e.g. 100.00 means one hundred).

Parameters

namestringRequiredstart_date_timestringRequiredend_date_timestringRequiredbudget_amountstringRequiredkpistringRequiredbid_strategystringtarget_kpistring

Update Campaign Update an Amazon DSP campaign: rename it and/or change its state. Setting state=ACTIVE starts delivery (the campaign must have active ad groups with creatives), state=INACTIVE stops it. Both changes are reversible with another update_campaign call.

Update an Amazon DSP campaign: rename it and/or change its state. Setting state=ACTIVE starts delivery (the campaign must have active ad groups with creatives), state=INACTIVE stops it. Both changes are reversible with another update_campaign call.

Parameters

campaign_idstringRequirednamestringstatestring

Amazon DSP Fields

Amazon DSP dsp_campaign fields

The dsp_campaign report of the Amazon DSP connector includes 69 fields.

Amazon DSP dsp_campaign fields (dsp_campaign__add_to_cart to dsp_campaign__purchases_clicks)

ID	Type	Name	Description
dsp_campaign__add_to_cart	NUMERIC	DSP Campaign: Add To Cart	Add-to-cart events attributed to the ad
dsp_campaign__add_to_list	NUMERIC	DSP Campaign: Add To List	Add-to-list events attributed to the ad
dsp_campaign__agency_fee	NUMERIC	DSP Campaign: Agency Fee	The agency fee charged
dsp_campaign__amazon_dsp_audience_fee	NUMERIC	DSP Campaign: Amazon DSP Audience Fee	The Amazon DSP audience fee charged
dsp_campaign__amazon_dsp_console_fee	NUMERIC	DSP Campaign: Amazon DSP Console Fee	The Amazon DSP console fee charged
dsp_campaign__brand_searches	NUMERIC	DSP Campaign: Brand Searches	Brand searches attributed to the ad
dsp_campaign__click_through_rate	NUMERIC	DSP Campaign: Click Through Rate	Clicks divided by impressions
dsp_campaign__clicks	NUMERIC	DSP Campaign: Clicks	The number of times the ad was clicked
dsp_campaign__detail_page_views	NUMERIC	DSP Campaign: Detail Page Views	Detail page views of promoted products attributed to the ad
dsp_campaign__ecpc	NUMERIC	DSP Campaign: eCPC	The effective cost per click
dsp_campaign__ecpm	NUMERIC	DSP Campaign: eCPM	The effective cost per thousand impressions
dsp_campaign__erpm	NUMERIC	DSP Campaign: eRPM	The effective return per thousand impressions
dsp_campaign__frequency_average	NUMERIC	DSP Campaign: Frequency Average	The average number of exposures per unique user
dsp_campaign__gross_impressions	NUMERIC	DSP Campaign: Gross Impressions	The total number of impressions including invalid ones
dsp_campaign__household_frequency_average	NUMERIC	DSP Campaign: Household Frequency Average	The average number of exposures per unique household
dsp_campaign__household_reach	NUMERIC	DSP Campaign: Household Reach	The number of unique households exposed to the ad
dsp_campaign__impressions	NUMERIC	DSP Campaign: Impressions	The number of times the ad was displayed
dsp_campaign__invalid_impressions	NUMERIC	DSP Campaign: Invalid Impressions	The number of impressions identified as invalid traffic
dsp_campaign__long_term_roas	NUMERIC	DSP Campaign: Long Term ROAS	Predicted long-term return on advertising spend
dsp_campaign__long_term_sales	NUMERIC	DSP Campaign: Long Term Sales	Predicted long-term sales attributed to the ad
dsp_campaign__measurable_impressions	NUMERIC	DSP Campaign: Measurable Impressions	The number of impressions measurable for viewability
dsp_campaign__measurable_rate	NUMERIC	DSP Campaign: Measurable Rate	Measurable impressions divided by impressions
dsp_campaign__new_to_brand_product_sales	NUMERIC	DSP Campaign: New To Brand Product Sales	Sales from customers new to the brand
dsp_campaign__new_to_brand_purchases	NUMERIC	DSP Campaign: New To Brand Purchases	Purchases made by customers new to the brand
dsp_campaign__new_to_brand_roas	NUMERIC	DSP Campaign: New To Brand ROAS	Return on advertising spend from customers new to the brand
dsp_campaign__new_to_brand_units_sold	NUMERIC	DSP Campaign: New To Brand Units Sold	Units sold to customers new to the brand
dsp_campaign__off_amazon_conversions	NUMERIC	DSP Campaign: Off Amazon Conversions	Off-Amazon conversions attributed to the ad
dsp_campaign__off_amazon_product_sales	NUMERIC	DSP Campaign: Off Amazon Product Sales	Off-Amazon sales attributed to the ad
dsp_campaign__off_amazon_purchases	NUMERIC	DSP Campaign: Off Amazon Purchases	Off-Amazon purchases attributed to the ad
dsp_campaign__off_amazon_roas	NUMERIC	DSP Campaign: Off Amazon ROAS	Return on advertising spend for off-Amazon conversions
dsp_campaign__order_budget	NUMERIC	DSP Campaign: Order Budget	Total budget allotted to the order
dsp_campaign__order_currency	TEXT	DSP Campaign: Order Currency	The currency of the order
dsp_campaign__order_end_time	TIMESTAMP	DSP Campaign: Order End Time	The end date of the order
dsp_campaign__order_external_id	TEXT	DSP Campaign: Order External ID	The external identifier of the order
dsp_campaign__order_id	TEXT	DSP Campaign: Order ID	The unique identifier of the order (campaign)
dsp_campaign__order_name	TEXT	DSP Campaign: Order Name	The name of the order (campaign)
dsp_campaign__order_start_time	TIMESTAMP	DSP Campaign: Order Start Time	The start date of the order
dsp_campaign__purchase_rate	NUMERIC	DSP Campaign: Purchase Rate	Purchases divided by impressions
dsp_campaign__purchases	NUMERIC	DSP Campaign: Purchases	Purchases of promoted products attributed to the ad
dsp_campaign__purchases_clicks	NUMERIC	DSP Campaign: Purchases Clicks	Purchases attributed to an ad click

Amazon DSP dsp_campaign fields (dsp_campaign__purchases_views to dsp_campaign__viewable_impressions)

ID	Type	Name	Description
dsp_campaign__purchases_views	NUMERIC	DSP Campaign: Purchases Views	Purchases attributed to an ad view
dsp_campaign__reach	NUMERIC	DSP Campaign: Reach	The number of unique users exposed to the ad
dsp_campaign__roas	NUMERIC	DSP Campaign: ROAS	Return on advertising spend for promoted products
dsp_campaign__sales	NUMERIC	DSP Campaign: Sales	Sales of promoted products attributed to the ad
dsp_campaign__supply_cost	NUMERIC	DSP Campaign: Supply Cost	The cost of the inventory purchased
dsp_campaign__third_party_fees	NUMERIC	DSP Campaign: Third Party Fees	The sum of all third-party fees charged
dsp_campaign__total_cost	NUMERIC	DSP Campaign: Total Cost	The total cost including supply cost and fees
dsp_campaign__total_fee	NUMERIC	DSP Campaign: Total Fee	The sum of all fees charged
dsp_campaign__total_new_to_brand_detail_page_views	NUMERIC	DSP Campaign: Total New To Brand Detail Page Views	Detail page views from customers new to the brand including brand halo products
dsp_campaign__total_new_to_brand_purchase_rate	NUMERIC	DSP Campaign: Total New To Brand Purchase Rate	Rate of purchases by customers new to the brand including brand halo products
dsp_campaign__total_new_to_brand_purchases	NUMERIC	DSP Campaign: Total New To Brand Purchases	Purchases made by customers new to the brand including brand halo products
dsp_campaign__total_new_to_brand_roas	NUMERIC	DSP Campaign: Total New To Brand ROAS	Return on advertising spend from customers new to the brand including brand halo products
dsp_campaign__total_new_to_brand_sales	NUMERIC	DSP Campaign: Total New To Brand Sales	Sales from customers new to the brand including brand halo products
dsp_campaign__total_new_to_brand_units_sold	NUMERIC	DSP Campaign: Total New To Brand Units Sold	Units sold to customers new to the brand including brand halo products
dsp_campaign__total_purchases	NUMERIC	DSP Campaign: Total Purchases	Purchases including brand halo products
dsp_campaign__total_roas	NUMERIC	DSP Campaign: Total ROAS	Return on advertising spend including brand halo products
dsp_campaign__total_sales	NUMERIC	DSP Campaign: Total Sales	Sales including brand halo products attributed to the ad
dsp_campaign__total_units_sold	NUMERIC	DSP Campaign: Total Units Sold	Units sold including brand halo products
dsp_campaign__units_sold	NUMERIC	DSP Campaign: Units Sold	Units of promoted products sold attributed to the ad
dsp_campaign__video_ad_clicks	NUMERIC	DSP Campaign: Video Ad Clicks	The number of video ad clicks
dsp_campaign__video_ad_complete	NUMERIC	DSP Campaign: Video Ad Complete	The number of video ads played to completion
dsp_campaign__video_ad_completion_rate	NUMERIC	DSP Campaign: Video Ad Completion Rate	Video ad completions divided by video ad impressions
dsp_campaign__video_ad_first_quartile	NUMERIC	DSP Campaign: Video Ad First Quartile	The number of video ads played to the first quartile
dsp_campaign__video_ad_impressions	NUMERIC	DSP Campaign: Video Ad Impressions	The number of video ad impressions
dsp_campaign__video_ad_midpoint	NUMERIC	DSP Campaign: Video Ad Midpoint	The number of video ads played to the midpoint
dsp_campaign__video_ad_start	NUMERIC	DSP Campaign: Video Ad Start	The number of video ad starts
dsp_campaign__video_ad_third_quartile	NUMERIC	DSP Campaign: Video Ad Third Quartile	The number of video ads played to the third quartile
dsp_campaign__viewability_rate	NUMERIC	DSP Campaign: Viewability Rate	Viewable impressions divided by measurable impressions
dsp_campaign__viewable_impressions	NUMERIC	DSP Campaign: Viewable Impressions	The number of impressions considered viewable

Amazon DSP dsp_creative fields

The dsp_creative report of the Amazon DSP connector includes 24 fields.

ID	Type	Name	Description
dsp_creative__click_through_rate	NUMERIC	DSP Creative: Click Through Rate	Clicks divided by impressions
dsp_creative__clicks	NUMERIC	DSP Creative: Clicks	The number of times the ad was clicked
dsp_creative__creative_id	TEXT	DSP Creative: Creative ID	The unique identifier of the creative
dsp_creative__creative_language	TEXT	DSP Creative: Creative Language	The language of the creative
dsp_creative__creative_name	TEXT	DSP Creative: Creative Name	The name of the creative
dsp_creative__creative_size	TEXT	DSP Creative: Creative Size	The size of the creative
dsp_creative__creative_type	TEXT	DSP Creative: Creative Type	The type of the creative
dsp_creative__detail_page_views	NUMERIC	DSP Creative: Detail Page Views	Detail page views of promoted products attributed to the ad
dsp_creative__ecpc	NUMERIC	DSP Creative: eCPC	The effective cost per click
dsp_creative__ecpm	NUMERIC	DSP Creative: eCPM	The effective cost per thousand impressions
dsp_creative__impressions	NUMERIC	DSP Creative: Impressions	The number of times the ad was displayed
dsp_creative__order_id	TEXT	DSP Creative: Order ID	The unique identifier of the order (campaign)
dsp_creative__order_name	TEXT	DSP Creative: Order Name	The name of the order (campaign)
dsp_creative__purchases	NUMERIC	DSP Creative: Purchases	Purchases of promoted products attributed to the ad
dsp_creative__roas	NUMERIC	DSP Creative: ROAS	Return on advertising spend for promoted products
dsp_creative__sales	NUMERIC	DSP Creative: Sales	Sales of promoted products attributed to the ad
dsp_creative__supply_cost	NUMERIC	DSP Creative: Supply Cost	The cost of the inventory purchased
dsp_creative__total_cost	NUMERIC	DSP Creative: Total Cost	The total cost including supply cost and fees
dsp_creative__units_sold	NUMERIC	DSP Creative: Units Sold	Units of promoted products sold attributed to the ad
dsp_creative__video_ad_complete	NUMERIC	DSP Creative: Video Ad Complete	The number of video ads played to completion
dsp_creative__video_ad_completion_rate	NUMERIC	DSP Creative: Video Ad Completion Rate	Video ad completions divided by video ad impressions
dsp_creative__video_ad_start	NUMERIC	DSP Creative: Video Ad Start	The number of video ad starts
dsp_creative__viewability_rate	NUMERIC	DSP Creative: Viewability Rate	Viewable impressions divided by measurable impressions
dsp_creative__viewable_impressions	NUMERIC	DSP Creative: Viewable Impressions	The number of impressions considered viewable

Amazon DSP dsp_line_item fields

The dsp_line_item report of the Amazon DSP connector includes 38 fields.

ID	Type	Name	Description
dsp_line_item__click_through_rate	NUMERIC	DSP Line Item: Click Through Rate	Clicks divided by impressions
dsp_line_item__clicks	NUMERIC	DSP Line Item: Clicks	The number of times the ad was clicked
dsp_line_item__detail_page_views	NUMERIC	DSP Line Item: Detail Page Views	Detail page views of promoted products attributed to the ad
dsp_line_item__ecpc	NUMERIC	DSP Line Item: eCPC	The effective cost per click
dsp_line_item__ecpm	NUMERIC	DSP Line Item: eCPM	The effective cost per thousand impressions
dsp_line_item__frequency_average	NUMERIC	DSP Line Item: Frequency Average	The average number of exposures per unique user
dsp_line_item__household_reach	NUMERIC	DSP Line Item: Household Reach	The number of unique households exposed to the ad
dsp_line_item__impressions	NUMERIC	DSP Line Item: Impressions	The number of times the ad was displayed
dsp_line_item__line_item_budget	NUMERIC	DSP Line Item: Line Item Budget	Total budget allotted to the line item
dsp_line_item__line_item_delivery_rate	NUMERIC	DSP Line Item: Line Item Delivery Rate	The delivery rate of the line item
dsp_line_item__line_item_end_time	TIMESTAMP	DSP Line Item: Line Item End Time	The end date of the line item
dsp_line_item__line_item_external_id	TEXT	DSP Line Item: Line Item External ID	The external identifier of the line item
dsp_line_item__line_item_id	TEXT	DSP Line Item: Line Item ID	The unique identifier of the line item
dsp_line_item__line_item_name	TEXT	DSP Line Item: Line Item Name	The name of the line item
dsp_line_item__line_item_start_time	TIMESTAMP	DSP Line Item: Line Item Start Time	The start date of the line item
dsp_line_item__line_item_status	TEXT	DSP Line Item: Line Item Status	The status of the line item
dsp_line_item__line_item_type	TEXT	DSP Line Item: Line Item Type	The type of the line item
dsp_line_item__on_target_cpm	NUMERIC	DSP Line Item: On Target CPM	The cost per thousand on-target impressions
dsp_line_item__on_target_impression_cost	NUMERIC	DSP Line Item: On Target Impression Cost	The cost of on-target impressions
dsp_line_item__on_target_impressions	NUMERIC	DSP Line Item: On Target Impressions	Impressions delivered to the target demographic
dsp_line_item__order_id	TEXT	DSP Line Item: Order ID	The unique identifier of the order (campaign)
dsp_line_item__order_name	TEXT	DSP Line Item: Order Name	The name of the order (campaign)
dsp_line_item__purchases	NUMERIC	DSP Line Item: Purchases	Purchases of promoted products attributed to the ad
dsp_line_item__reach	NUMERIC	DSP Line Item: Reach	The number of unique users exposed to the ad
dsp_line_item__roas	NUMERIC	DSP Line Item: ROAS	Return on advertising spend for promoted products
dsp_line_item__sales	NUMERIC	DSP Line Item: Sales	Sales of promoted products attributed to the ad
dsp_line_item__supply_cost	NUMERIC	DSP Line Item: Supply Cost	The cost of the inventory purchased
dsp_line_item__target_demographic	TEXT	DSP Line Item: Target Demographic	The target demographic of the line item
dsp_line_item__total_cost	NUMERIC	DSP Line Item: Total Cost	The total cost including supply cost and fees
dsp_line_item__total_purchases	NUMERIC	DSP Line Item: Total Purchases	Purchases including brand halo products
dsp_line_item__total_roas	NUMERIC	DSP Line Item: Total ROAS	Return on advertising spend including brand halo products
dsp_line_item__total_sales	NUMERIC	DSP Line Item: Total Sales	Sales including brand halo products attributed to the ad
dsp_line_item__units_sold	NUMERIC	DSP Line Item: Units Sold	Units of promoted products sold attributed to the ad
dsp_line_item__video_ad_complete	NUMERIC	DSP Line Item: Video Ad Complete	The number of video ads played to completion
dsp_line_item__video_ad_completion_rate	NUMERIC	DSP Line Item: Video Ad Completion Rate	Video ad completions divided by video ad impressions
dsp_line_item__video_ad_start	NUMERIC	DSP Line Item: Video Ad Start	The number of video ad starts
dsp_line_item__viewability_rate	NUMERIC	DSP Line Item: Viewability Rate	Viewable impressions divided by measurable impressions
dsp_line_item__viewable_impressions	NUMERIC	DSP Line Item: Viewable Impressions	The number of impressions considered viewable

Amazon DSP other fields

The Amazon DSP connector has 28 fields that do not belong to a named report, or belong to a report with only one or two fields.

ID	Type	Name	Description	Report
account_id	TEXT	Account ID	The DSP advertiser ID used as the account ID
account_name	TEXT	Account Name	The DSP advertiser name used as the account name
advertiserid	TEXT	Advertiser ID	The DSP advertiser ID
advertisername	TEXT	Advertiser Name	The DSP advertiser name
data_fetched_at	TIMESTAMP	Data fetched at	UTC timestamp (second precision) of when the connector request that pulled the row started. Freshly pulled rows show this request's start time; cache hits keep the start time of the request that filled the cache. Selecting this field disables aggregation, so rows are returned individually (each keeping its own fetch time) instead of being summed.
datasource	TEXT	Data Source	The name of the Windsor connector returning the row
date	DATE	Date	Date
day_of_month	TEXT	Day of month	Day of the month
dsp_reach_frequency__frequency_average	NUMERIC	DSP Reach Frequency: Frequency Average	The average number of exposures per unique user	dsp_reach_frequency
dsp_reach_frequency__reach	NUMERIC	DSP Reach Frequency: Reach	The number of unique users exposed to the advertiser's ads	dsp_reach_frequency
entity_id	TEXT	Entity ID	The DSP entity (seat) ID the advertiser belongs to
marketplace	TEXT	Marketplace	Amazon marketplace (country) code
month	TEXT	Month	Number of the month
now	TIMESTAMP	Now	Current timestamp
profileid	TEXT	Profile ID	The Amazon Ads agency profile ID used for API access
source	TEXT	Source	The name of the Windsor connector returning the row
today	DATE	Today	Today's date
week	TEXT	Week	Week (Sun-Sat).
week_day	TEXT	Day of week and day number	Weekday number and name combined (Sun-Sat).Numbered from 0 Sunday to 6 Saturday.
week_day_iso	TEXT	Day of week and day number, ISO	Weekday number and name combined, ISO format (Mon-Sun).Numbered from 1 Monday to 7
week_iso	TEXT	Week ISO	Week, ISO format (Mon-Sun).
year	TEXT	Year	Year
year_month	TEXT	Yearmonth	Year and month, e.g. 2024\|3
year_month_name	TEXT	Year month name	Year and month with the month name written out, e.g. "Jan 2025".
year_of_week	TEXT	Year of week	The year that contains first day of the week (Sun-Sat).
year_of_week_iso	TEXT	Year of week, ISO	The year that contains first day of the ISO week (Mon-Sun).
year_week	TEXT	Year week	Year and week for US weeks (Sun-Sat), e.g. 2024\|15
year_week_iso	TEXT	Year week ISO	Year and week for ISO weeks (Mon-Sun), e.g. 2024\|20

API Connectors