Twitter Ads Connector Reference

252 metrics53 dimensions

Fields

https://connectors.windsor.ai/twitter?api_key=[your API key]&date_preset=last_7d&fields=campaign,clicks,spend,impressions,date,source

The Twitter Ads connector exposes 305 fields (252 metrics, 53 dimensions). Every field ID below can be passed to the Windsor.ai API in the fields parameter.

Twitter Ads Fields

Twitter Ads Cost Performance fields

The Cost Performance report of the Twitter Ads connector includes 9 fields.

ID	Type	Name	Description
click_rate	PERCENT	Click Rate	Total number of clicks divided by impressions.
cost_per_view	NUMERIC	Cost Per View	Total spend divided by the number of video views.
cpac	NUMERIC	CPAC	Total spend divided by the number of app clicks.
cpc	NUMERIC	CPC	The average cost for each click (all).
cpe	NUMERIC	CPE	Total spend divided by the number of engagements.
cpf	NUMERIC	CPF	Total spend divided by the number of followers.
cpm	NUMERIC	CPM	The average cost for 1,000 impressions.
follow_rate	NUMERIC	Follow Rate	Total number of followers divided by the number of impressions.
media_view_rate	NUMERIC	Media View Rate	Total number of media views divided by the number of impressions.

Twitter Ads other fields

The Twitter Ads connector has 296 fields that do not belong to a named report, or belong to a report with only one or two fields.

Twitter Ads other fields (account_id to conversion_checkouts_initiated_sale_amount_engagement)

ID	Type	Name	Description	Report
account_id	TEXT	Account ID	Your Twitter ads account ID
account_name	TEXT	Account Name	Your Twitter ads account name
ad_name	TEXT	Ad Name	The Ad Name
ad_preview	TEXT	Ad Preview URL	URL for the Ad preview.
adgroup	TEXT	Ad Group	The Ad Group Name
age	TEXT	Age segment	Age segment
app_clicks	NUMERIC	App Clicks	Total number of app install or app open attempts
app_store_category	TEXT	App Store Category segment	App Store Category segment
audience_segment	TEXT	Audience segment	Audience segment
average_frequency_reach	NUMERIC	Average Frequency Reach	The average number of times a person saw ads related to this campaign.	Reach
campaign	TEXT	Campaign	The Campaign Name
campaign_end_date	DATE	Campaign End Date	End date of the campaign.
campaign_id	TEXT	Campaign ID	The Campaign ID
campaign_standard_pacing	BOOLEAN	Campaign Standard Pacing	Whether standard (true) or accelerated (false) delivery activated. Only available when budget_optimization is set to CAMPAIGN.
campaign_start_date	DATE	Campaign Start Date	Start date of the campaign.
campaign_status	TEXT	Campaign Status	The campaign status.
card_engagements	NUMERIC	Card Engagements	Total number of card engagements
clicks	NUMERIC	Clicks	Total number of clicks, including favorites and other engagements
conversation	TEXT	Conversation segment	Conversation segment
conversion_add_to_carts	NUMERIC	conversion_add_to_carts	Number of web conversions of type ADD_TO_CART.
conversion_add_to_carts_assisted	NUMERIC	conversion_add_to_carts_assisted	Breakdown of web conversions of type ADD_TO_CART by assisted.
conversion_add_to_carts_metric	NUMERIC	conversion_add_to_carts_metric	Breakdown of web conversions of type ADD_TO_CART by metric.
conversion_add_to_carts_order_quantity	NUMERIC	conversion_add_to_carts_order_quantity	Breakdown of web conversions of type ADD_TO_CART by order_quantity.
conversion_add_to_carts_order_quantity_engagement	NUMERIC	conversion_add_to_carts_order_quantity_engagement	Breakdown of web conversions of type ADD_TO_CART by order_quantity_engagement.
conversion_add_to_carts_order_quantity_view	NUMERIC	conversion_add_to_carts_order_quantity_view	Breakdown of web conversions of type ADD_TO_CART by order_quantity_view.
conversion_add_to_carts_post_engagement	NUMERIC	conversion_add_to_carts_post_engagement	Breakdown of web conversions of type ADD_TO_CART by post_engagement.
conversion_add_to_carts_post_view	NUMERIC	conversion_add_to_carts_post_view	Breakdown of web conversions of type ADD_TO_CART by post_view.
conversion_add_to_carts_sale_amount	NUMERIC	conversion_add_to_carts_sale_amount	Breakdown of web conversions of type ADD_TO_CART by sale_amount.
conversion_add_to_carts_sale_amount_engagement	NUMERIC	conversion_add_to_carts_sale_amount_engagement	Breakdown of web conversions of type ADD_TO_CART by sale_amount_engagement.
conversion_add_to_carts_sale_amount_view	NUMERIC	conversion_add_to_carts_sale_amount_view	Breakdown of web conversions of type ADD_TO_CART by sale_amount_view.
conversion_checkouts_initiated	NUMERIC	conversion_checkouts_initiated	Number of web conversions of type CHECKOUT_INITIATED.
conversion_checkouts_initiated_assisted	NUMERIC	conversion_checkouts_initiated_assisted	Breakdown of web conversions of type CHECKOUT_INITIATED by assisted.
conversion_checkouts_initiated_metric	NUMERIC	conversion_checkouts_initiated_metric	Breakdown of web conversions of type CHECKOUT_INITIATED by metric.
conversion_checkouts_initiated_order_quantity	NUMERIC	conversion_checkouts_initiated_order_quantity	Breakdown of web conversions of type CHECKOUT_INITIATED by order_quantity.
conversion_checkouts_initiated_order_quantity_engagement	NUMERIC	conversion_checkouts_initiated_order_quantity_engagement	Breakdown of web conversions of type CHECKOUT_INITIATED by order_quantity_engagement.
conversion_checkouts_initiated_order_quantity_view	NUMERIC	conversion_checkouts_initiated_order_quantity_view	Breakdown of web conversions of type CHECKOUT_INITIATED by order_quantity_view.
conversion_checkouts_initiated_post_engagement	NUMERIC	conversion_checkouts_initiated_post_engagement	Breakdown of web conversions of type CHECKOUT_INITIATED by post_engagement.
conversion_checkouts_initiated_post_view	NUMERIC	conversion_checkouts_initiated_post_view	Breakdown of web conversions of type CHECKOUT_INITIATED by post_view.
conversion_checkouts_initiated_sale_amount	NUMERIC	conversion_checkouts_initiated_sale_amount	Breakdown of web conversions of type CHECKOUT_INITIATED by sale_amount.
conversion_checkouts_initiated_sale_amount_engagement	NUMERIC	conversion_checkouts_initiated_sale_amount_engagement	Breakdown of web conversions of type CHECKOUT_INITIATED by sale_amount_engagement.

Twitter Ads other fields (conversion_checkouts_initiated_sale_amount_view to conversion_page_views_post_view)

Twitter Ads other fields (conversion_page_views_sale_amount to datasource)

Twitter Ads other fields (date to mobile_conversion_checkouts_initiated_sale_amount)

ID	Type	Name	Description
date	DATE	Date	The Date
day_of_month	TEXT	Day of month	Day of the month
engagements	NUMERIC	Engagements	Sum of clicks, likes, retweets, replies and follows. Does not include media, card or video engagements -- use `total_engagements` for the broader total.
event	TEXT	Event segment	Event segment
follows	NUMERIC	Follows	Total number of follows
funding_instrument_able_to_fund	BOOLEAN	Funding Instrument Able To Fund	Whether this funding instrument is able to fund the campaign.
funding_instrument_credit_limit	NUMERIC	Funding Instrument Credit Limit	The total credit available against this funding instrument. NOTE: Only valid for CREDIT_CARD or CREDIT_LINE type funding instruments.
funding_instrument_description	TEXT	Funding Instrument Description	The description of funding instrument.
funding_instrument_funded_amount	NUMERIC	Funding Instrument Funded Amount	The total budget amount allocated to this funding instrument. NOTE: Only valid for INSERTION_ORDER type funding instruments
funding_instrument_remaining_budget	NUMERIC	Funding Instrument Remaining Budget Amount	The remaining budget amount for this funding instrument. NOTE: Only valid for CREDIT_LINE and AGENCY_CREDIT_LINE type funding instruments.
funding_instrument_type	TEXT	Funding Instrument Type	The type of funding instrument.
gender	TEXT	Gender segment	Gender segment
impressions	NUMERIC	Impressions	Total number of impressions
interest	TEXT	Interest segment	Interest segment
keyword	TEXT	Keyword segment	Keyword segment
language	TEXT	Language segment	Language segment
likes	NUMERIC	Likes	Total number of likes
location	TEXT	Location segment	Location segment
media_engagements	NUMERIC	Media Engagements	Total number of clicks of media across Videos, Vines, GIFs, and Images.
media_views	NUMERIC	Media Views	Total number of views (autoplay and click) of media across Videos, Vines, GIFs, and Images.
mobile_conversion_achievements_unlocked_assisted	NUMERIC	mobile_conversion_achievements_unlocked_assisted	Breakdown of mobile conversions of type ACHIEVEMENT_UNLOCKED by assisted.
mobile_conversion_achievements_unlocked_order_quantity	NUMERIC	mobile_conversion_achievements_unlocked_order_quantity	Breakdown of mobile conversions of type ACHIEVEMENT_UNLOCKED by order_quantity.
mobile_conversion_achievements_unlocked_post_engagement	NUMERIC	mobile_conversion_achievements_unlocked_post_engagement	Breakdown of mobile conversions of type ACHIEVEMENT_UNLOCKED by post_engagement.
mobile_conversion_achievements_unlocked_post_view	NUMERIC	mobile_conversion_achievements_unlocked_post_view	Breakdown of mobile conversions of type ACHIEVEMENT_UNLOCKED by post_view.
mobile_conversion_achievements_unlocked_sale_amount	NUMERIC	mobile_conversion_achievements_unlocked_sale_amount	Breakdown of mobile conversions of type ACHIEVEMENT_UNLOCKED by sale_amount.
mobile_conversion_add_to_carts_assisted	NUMERIC	mobile_conversion_add_to_carts_assisted	Breakdown of mobile conversions of type ADD_TO_CART by assisted.
mobile_conversion_add_to_carts_order_quantity	NUMERIC	mobile_conversion_add_to_carts_order_quantity	Breakdown of mobile conversions of type ADD_TO_CART by order_quantity.
mobile_conversion_add_to_carts_post_engagement	NUMERIC	mobile_conversion_add_to_carts_post_engagement	Breakdown of mobile conversions of type ADD_TO_CART by post_engagement.
mobile_conversion_add_to_carts_post_view	NUMERIC	mobile_conversion_add_to_carts_post_view	Breakdown of mobile conversions of type ADD_TO_CART by post_view.
mobile_conversion_add_to_carts_sale_amount	NUMERIC	mobile_conversion_add_to_carts_sale_amount	Breakdown of mobile conversions of type ADD_TO_CART by sale_amount.
mobile_conversion_add_to_wishlists_assisted	NUMERIC	mobile_conversion_add_to_wishlists_assisted	Breakdown of mobile conversions of type ADD_TO_WISHLIST by assisted.
mobile_conversion_add_to_wishlists_order_quantity	NUMERIC	mobile_conversion_add_to_wishlists_order_quantity	Breakdown of mobile conversions of type ADD_TO_WISHLIST by order_quantity.
mobile_conversion_add_to_wishlists_post_engagement	NUMERIC	mobile_conversion_add_to_wishlists_post_engagement	Breakdown of mobile conversions of type ADD_TO_WISHLIST by post_engagement.
mobile_conversion_add_to_wishlists_post_view	NUMERIC	mobile_conversion_add_to_wishlists_post_view	Breakdown of mobile conversions of type ADD_TO_WISHLIST by post_view.
mobile_conversion_add_to_wishlists_sale_amount	NUMERIC	mobile_conversion_add_to_wishlists_sale_amount	Breakdown of mobile conversions of type ADD_TO_WISHLIST by sale_amount.
mobile_conversion_checkouts_initiated_assisted	NUMERIC	mobile_conversion_checkouts_initiated_assisted	Breakdown of mobile conversions of type CHECKOUT_INITIATED by assisted.
mobile_conversion_checkouts_initiated_order_quantity	NUMERIC	mobile_conversion_checkouts_initiated_order_quantity	Breakdown of mobile conversions of type CHECKOUT_INITIATED by order_quantity.
mobile_conversion_checkouts_initiated_post_engagement	NUMERIC	mobile_conversion_checkouts_initiated_post_engagement	Breakdown of mobile conversions of type CHECKOUT_INITIATED by post_engagement.
mobile_conversion_checkouts_initiated_post_view	NUMERIC	mobile_conversion_checkouts_initiated_post_view	Breakdown of mobile conversions of type CHECKOUT_INITIATED by post_view.
mobile_conversion_checkouts_initiated_sale_amount	NUMERIC	mobile_conversion_checkouts_initiated_sale_amount	Breakdown of mobile conversions of type CHECKOUT_INITIATED by sale_amount.

Twitter Ads other fields (mobile_conversion_content_views_assisted to mobile_conversion_purchases_assisted)

Twitter Ads other fields (mobile_conversion_purchases_order_quantity to mobile_conversion_site_visits_sale_amount)

Twitter Ads other fields (mobile_conversion_spent_credits_assisted to video_cta_clicks)

ID	Type	Name	Description	Report
mobile_conversion_spent_credits_assisted	NUMERIC	mobile_conversion_spent_credits_assisted	Breakdown of mobile conversions of type SPENT_CREDIT by assisted.
mobile_conversion_spent_credits_order_quantity	NUMERIC	mobile_conversion_spent_credits_order_quantity	Breakdown of mobile conversions of type SPENT_CREDIT by order_quantity.
mobile_conversion_spent_credits_post_engagement	NUMERIC	mobile_conversion_spent_credits_post_engagement	Breakdown of mobile conversions of type SPENT_CREDIT by post_engagement.
mobile_conversion_spent_credits_post_view	NUMERIC	mobile_conversion_spent_credits_post_view	Breakdown of mobile conversions of type SPENT_CREDIT by post_view.
mobile_conversion_spent_credits_sale_amount	NUMERIC	mobile_conversion_spent_credits_sale_amount	Breakdown of mobile conversions of type SPENT_CREDIT by sale_amount.
mobile_conversion_tutorials_completed_assisted	NUMERIC	mobile_conversion_tutorials_completed_assisted	Breakdown of mobile conversions of type TUTORIAL_COMPLETED by assisted.
mobile_conversion_tutorials_completed_order_quantity	NUMERIC	mobile_conversion_tutorials_completed_order_quantity	Breakdown of mobile conversions of type TUTORIAL_COMPLETED by order_quantity.
mobile_conversion_tutorials_completed_post_engagement	NUMERIC	mobile_conversion_tutorials_completed_post_engagement	Breakdown of mobile conversions of type TUTORIAL_COMPLETED by post_engagement.
mobile_conversion_tutorials_completed_post_view	NUMERIC	mobile_conversion_tutorials_completed_post_view	Breakdown of mobile conversions of type TUTORIAL_COMPLETED by post_view.
mobile_conversion_tutorials_completed_sale_amount	NUMERIC	mobile_conversion_tutorials_completed_sale_amount	Breakdown of mobile conversions of type TUTORIAL_COMPLETED by sale_amount.
mobile_conversion_updates_assisted	NUMERIC	mobile_conversion_updates_assisted	Breakdown of mobile conversions of type UPDATE by assisted.
mobile_conversion_updates_order_quantity	NUMERIC	mobile_conversion_updates_order_quantity	Breakdown of mobile conversions of type UPDATE by order_quantity.
mobile_conversion_updates_post_engagement	NUMERIC	mobile_conversion_updates_post_engagement	Breakdown of mobile conversions of type UPDATE by post_engagement.
mobile_conversion_updates_post_view	NUMERIC	mobile_conversion_updates_post_view	Breakdown of mobile conversions of type UPDATE by post_view.
mobile_conversion_updates_sale_amount	NUMERIC	mobile_conversion_updates_sale_amount	Breakdown of mobile conversions of type UPDATE by sale_amount.
month	TEXT	Month	Number of the month
now	TIMESTAMP	Now	Current timestamp
objective	TEXT	objective	objective description
platform	TEXT	Platform segment	Platform segment
promoted_tweet_id	TEXT	Promoted Tweet ID	Promoted Tweet ID
qualified_impressions	NUMERIC	Qualified Impressions	Total number of qualified impressions
replies	NUMERIC	Replies	Total number of replies
retweets	NUMERIC	Retweets	Total number of retweets
similar_followers	TEXT	Similar To Followers Of User segment	Similar To Followers Of User segment
slide	TEXT	Slide segment	Slide segment
source	TEXT	Source	The name of the Windsor connector returning the row
spend	NUMERIC	Spend	The total media spend (Duplicate)
today	DATE	Today	Today's date
total_audience_reach	NUMERIC	Total Audience Reach	The total number of people who have been reached by the campaign.	Reach
total_budget	NUMERIC	Total Budget Amount	The total budget amount to be allocated to the campaign.
total_engagements	NUMERIC	Total Engagements	Sum of engagements, media_engagements, card_engagements and video_total_views. Approximates the Engagements column in X Ads Manager for Post Engagement campaigns.
totalcost	NUMERIC	Spend	The total media spend
tv_show	TEXT	TV Show segment	TV Show segment
twitter_handle	TEXT	Twitter Handle	Your Twitter handle linked to your Ad account
url_clicks	NUMERIC	URL Clicks	Total clicks on the link or Website Card in an ad, including earned.
video_15s_views	NUMERIC	Video 15s views	Total number of views where at least 15 seconds of the video or for 95% of the total duration was viewed
video_3s100pct_views	NUMERIC	Video 3s100pct views	Total number of views where at least 3 seconds were played while 100% in view (legacy video_total_views)
video_6s_views	NUMERIC	Video 6s views	Total number of views where at least 6 seconds of the video was viewed
video_content_starts	NUMERIC	Video content starts	Total number of video playback starts
video_cta_clicks	NUMERIC	Video cta clicks	Total clicks on the call to action

Twitter Ads other fields (video_total_views to year_week_iso)

ID	Type	Name	Description
video_total_views	NUMERIC	Video total views	Total number of video views
video_views_100	NUMERIC	Video views 100	Total number of views where at least 100% of the video was viewed.
video_views_25	NUMERIC	Video views 25	Total number of views where at least 25% of the video was viewed.
video_views_50	NUMERIC	Video views 50	Total number of views where at least 50% of the video was viewed.
video_views_75	NUMERIC	Video views 75	Total number of views where at least 75% of the video was viewed.
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