API Connectors

users-love-us medal soc2
Send your Branch data to
Data StudioGoogle SheetsChatGPTClaudePower BIExcelTableauGoogle BigQueryAmazon S3Azure Blob StorageSnowflakeMySQLPostgreSQLPythonAzure SQLAmazon RedshiftDatabricksWindsor MCPMicrosoft FabricCopilot AgentPerplexityLovableAntigravitySupabase

Branch Connector Reference

43 metrics97 dimensions
Fields Options

The Branch connector exposes 140 fields (43 metrics, 97 dimensions). Every field ID below can be passed to the Windsor.ai API in the fields parameter.


Available options


aggregation Aggregation

How to count events towards the final result count. When using unique_count, each event is only counted if an event by that user has not already been seen. Default: total_count

Possible values (5)
total_countunique_countrevenuecostcost_in_local_currency
enable_install_recalculation Enable Install Recalculation

This field related to Result formatting. De-dupe unattributed installs caused by duplicate events from non-opt-in users coming from paid ads. Default: false


Branch Fields

The Branch connector includes 140 fields.

Branch fields (account_id to eo_pageview)

ID Type Name Description
account_id TEXT Account ID Account ID of the connected Branch account
account_name TEXT Account name Account name of the connected Branch account
attributed BOOLEAN Is attributed Whether the event was attributed to any touch (click or impression) as opposed to unattributed (attributed: false). Unattributed data is the same as organic or direct data
clicks NUMERIC Clicks Number of times users tapped on a Branch link, or on an ad where Branch is able to fetch click data from a third party (e.g. Facebook ads). Real-Time user-device level Link clicks are recorded through User Clicks on the Branch Links. SAN Ad Partner's clicks are not included in this bucket
commerce_event_add_payment_info NUMERIC ADD_PAYMENT_INFO ADD_PAYMENT_INFO commerce event value
commerce_event_add_to_cart NUMERIC ADD_TO_CART ADD_TO_CART commerce event value
commerce_event_add_to_wishlist NUMERIC ADD_TO_WISHLIST ADD_TO_WISHLIST commerce event value
commerce_event_click_ad NUMERIC CLICK_AD CLICK_AD commerce event value
commerce_event_initiate_purchase NUMERIC INITIATE_PURCHASE INITIATE_PURCHASE commerce event value
commerce_event_purchase NUMERIC PURCHASE PURCHASE commerce event value
commerce_event_reserve NUMERIC RESERVE RESERVE commerce event value
commerce_event_spend_credits NUMERIC SPEND_CREDITS SPEND_CREDITS commerce event value
commerce_event_view_ad NUMERIC VIEW_AD VIEW_AD commerce event value
commerce_event_view_cart NUMERIC VIEW_CART VIEW_CART commerce event value
content_event_complete_stream NUMERIC COMPLETE_STREAM COMPLETE_STREAM content event value
content_event_initiate_stream NUMERIC INITIATE_STREAM INITIATE_STREAM content event value
content_event_rate NUMERIC RATE RATE content event value
content_event_search NUMERIC SEARCH SEARCH content event value
content_event_share NUMERIC SHARE SHARE content event value
content_event_view_item NUMERIC VIEW_ITEM VIEW_ITEM content event value
content_event_view_items NUMERIC VIEW_ITEMS VIEW_ITEMS content event value
cost NUMERIC Cost Total cost (spend) for those dimensions (analytics tags, user data, time range), regardless of cost model
custom_event_count NUMERIC Custom Event Count Count of the custom event
custom_event_name TEXT Custom Event Name Name of the custom event
customer_event_alias TEXT Customer Event Alias Customer Event Alias
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 The Date
day_of_month TEXT Day of month Day of the month
days_from_last_attributed_touch_to_event TEXT Days From Last Attributed Touch To Event Days From Last Attributed Touch To Event
days_from_last_cta_view_to_event TEXT Days From Last Cta View To Event Days From Last Cta View To Event
deep_linked BOOLEAN Is deep linked Is the data deep linked?
eo_branch_cta_view NUMERIC Branch CTA Views The number of Branch CTA views. A banner or Deepview that renders in a user's browser
eo_commerce_event NUMERIC Commerce Events The number of attributed commerce events
eo_content_event NUMERIC Content Events The number of content events
eo_custom_event NUMERIC Custom Events (number) The number of custom events
eo_dismissal NUMERIC Dismissals The number of journey dismissal
eo_install NUMERIC App installs Installs attributed to this feature - installs are the first app open after downloading the app
eo_open NUMERIC App opens App opens attributed to your selected filters
eo_pageview NUMERIC Page views The number of attributed pageviews

Branch fields (eo_reinstall to last_attributed_touch_data_tilde_marketing_title)

ID Type Name Description
eo_reinstall NUMERIC App reinstalls Reinstalls attributed to your selected filters
eo_user_lifecycle_event NUMERIC User lifecycle events The number of user lifecycle events
eo_web_session_start NUMERIC Web sessions Web sessions attributed to your selected filters - triggered when a new tab for a website is opened, or when a Branch link is clicked that leads to the website
eo_web_to_app_auto_redirect NUMERIC Web To App Auto Redirects Number of times users were auto-redirected to the app without clicking, upon landing on a web page
event_data_custom_param_1 TEXT Event data custom parameter 1 Custom parameter 1.
event_data_custom_param_2 TEXT Event data custom parameter 2 Custom parameter 2.
event_data_custom_param_3 TEXT Event data custom parameter 3 Custom parameter 3.
event_data_product_categories TEXT Event Data Product Categories Event Data Product Categories
first_event_for_user TEXT First Event For User First Event For User
from_desktop BOOLEAN Is from desktop Is the data from Desktop?
impressions NUMERIC Impressions The number of ad impressions. Real-Time user-device level impressions/ad-views triggered via Impression Tracking Ad Links. SAN Ad Partner's impressions are not included in this data source.
last_attributed_touch_data_dollar_3p TEXT Last Attributed Touch Data Dollar 3p Last Attributed Touch Data Dollar 3p
last_attributed_touch_data_dollar_marketing_title TEXT Last Attributed Touch Data Dollar Marketing Title Last Attributed Touch Data Dollar Marketing Title
last_attributed_touch_data_plus_current_feature TEXT Last Attributed Touch Data Plus Current Feature Last Attributed Touch Data Plus Current Feature
last_attributed_touch_data_plus_via_features TEXT Last Attributed Touch Data Plus Via Features Last Attributed Touch Data Plus Via Features
last_attributed_touch_data_plus_web_format TEXT Last Attributed Touch Data Plus Web Format Last Attributed Touch Data Plus Web Format
last_attributed_touch_data_tilde_ad_id TEXT Last Attributed Touch Data Tilde Ad Id Last Attributed Touch Data Tilde Ad Id
last_attributed_touch_data_tilde_ad_name TEXT Last Attributed Touch Data Tilde Ad Name Last Attributed Touch Data Tilde Ad Name
last_attributed_touch_data_tilde_ad_set_id TEXT Last Attributed Touch Data Tilde Ad Set Id Last Attributed Touch Data Tilde Ad Set Id
last_attributed_touch_data_tilde_ad_set_name TEXT Last Attributed Touch Data Tilde Ad Set Name Last Attributed Touch Data Tilde Ad Set Name
last_attributed_touch_data_tilde_advertising_partner_name TEXT Last Attributed Touch Data Tilde Advertising Partner Name Last Attributed Touch Data Tilde Advertising Partner Name
last_attributed_touch_data_tilde_agency TEXT Last Attributed Touch Data Tilde Agency Last Attributed Touch Data Tilde Agency
last_attributed_touch_data_tilde_campaign TEXT Last Attributed Touch Data Tilde Campaign Last Attributed Touch Data Tilde Campaign
last_attributed_touch_data_tilde_campaign_id TEXT Last Attributed Touch Data Tilde Campaign Id Last Attributed Touch Data Tilde Campaign Id
last_attributed_touch_data_tilde_channel TEXT Last Attributed Touch Data Tilde Channel Last Attributed Touch Data Tilde Channel
last_attributed_touch_data_tilde_creative_id TEXT Last Attributed Touch Data Tilde Creative Id Last Attributed Touch Data Tilde Creative Id
last_attributed_touch_data_tilde_creative_name TEXT Last Attributed Touch Data Tilde Creative Name Last Attributed Touch Data Tilde Creative Name
last_attributed_touch_data_tilde_customer_ad_name TEXT Last Attributed Touch Data Tilde Customer Ad Name Last Attributed Touch Data Tilde Customer Ad Name
last_attributed_touch_data_tilde_customer_ad_set_name TEXT Last Attributed Touch Data Tilde Customer Ad Set Name Last Attributed Touch Data Tilde Customer Ad Set Name
last_attributed_touch_data_tilde_customer_campaign TEXT Last Attributed Touch Data Tilde Customer Campaign Last Attributed Touch Data Tilde Customer Campaign
last_attributed_touch_data_tilde_customer_keyword TEXT Last Attributed Touch Data Tilde Customer Keyword Last Attributed Touch Data Tilde Customer Keyword
last_attributed_touch_data_tilde_customer_placement TEXT Last Attributed Touch Data Tilde Customer Placement Last Attributed Touch Data Tilde Customer Placement
last_attributed_touch_data_tilde_customer_secondary_publisher TEXT Last Attributed Touch Data Tilde Customer Secondary Publisher Last Attributed Touch Data Tilde Customer Secondary Publisher
last_attributed_touch_data_tilde_customer_sub_site_name TEXT Last Attributed Touch Data Tilde Customer Sub Site Name Last Attributed Touch Data Tilde Customer Sub Site Name
last_attributed_touch_data_tilde_feature TEXT Last Attributed Touch Data Tilde Feature Last Attributed Touch Data Tilde Feature
last_attributed_touch_data_tilde_id TEXT Last Attributed Touch Data Tilde Id Branch link ID (LinkHub) of the last attributed touch
last_attributed_touch_data_tilde_journey_id TEXT Last Attributed Touch Data Tilde Journey Id Last Attributed Touch Data Tilde Journey Id
last_attributed_touch_data_tilde_keyword TEXT Last Attributed Touch Data Tilde Keyword Last Attributed Touch Data Tilde Keyword
last_attributed_touch_data_tilde_keyword_id TEXT Last Attributed Touch Data Tilde Keyword Id Last Attributed Touch Data Tilde Keyword Id
last_attributed_touch_data_tilde_marketing_title TEXT Last Attributed Touch Data Tilde Marketing Title Last Attributed Touch Data Tilde Marketing Title

Branch fields (last_attributed_touch_data_tilde_placement to user_data_geo_country_code)

ID Type Name Description
last_attributed_touch_data_tilde_placement TEXT Last Attributed Touch Data Tilde Placement Last Attributed Touch Data Tilde Placement
last_attributed_touch_data_tilde_secondary_publisher TEXT Last Attributed Touch Data Tilde Secondary Publisher Last Attributed Touch Data Tilde Secondary Publisher
last_attributed_touch_data_tilde_stage TEXT Last Attributed Touch Data Tilde Stage Last Attributed Touch Data Tilde Stage
last_attributed_touch_data_tilde_tags TEXT Last Attributed Touch Data Tilde Tags Last Attributed Touch Data Tilde Tags
last_attributed_touch_data_tilde_view_id TEXT Last Attributed Touch Data Tilde View Id Last Attributed Touch Data Tilde View Id
last_attributed_touch_data_tilde_view_name TEXT Last Attributed Touch Data Tilde View Name Last Attributed Touch Data Tilde View Name
last_attributed_touch_type TEXT Last Attributed Touch Type Last Attributed Touch Type
last_cta_view_data_dollar_3p TEXT Last Cta View Data Dollar 3p Last Cta View Data Dollar 3p
last_cta_view_data_plus_via_features TEXT Last Cta View Data Plus Via Features Last Cta View Data Plus Via Features
last_cta_view_data_plus_web_format TEXT Last Cta View Data Plus Web Format Last Cta View Data Plus Web Format
last_cta_view_data_tilde_ad_id TEXT Last Cta View Data Tilde Ad Id Last Cta View Data Tilde Ad Id
last_cta_view_data_tilde_ad_name TEXT Last Cta View Data Tilde Ad Name Last Cta View Data Tilde Ad Name
last_cta_view_data_tilde_ad_set_id TEXT Last Cta View Data Tilde Ad Set Id Last Cta View Data Tilde Ad Set Id
last_cta_view_data_tilde_ad_set_name TEXT Last Cta View Data Tilde Ad Set Name Last Cta View Data Tilde Ad Set Name
last_cta_view_data_tilde_advertising_partner_name TEXT Last Cta View Data Tilde Advertising Partner Name Last Cta View Data Tilde Advertising Partner Name
last_cta_view_data_tilde_campaign TEXT Last Cta View Data Tilde Campaign Last Cta View Data Tilde Campaign
last_cta_view_data_tilde_campaign_id TEXT Last Cta View Data Tilde Campaign Id Last Cta View Data Tilde Campaign Id
last_cta_view_data_tilde_channel TEXT Last Cta View Data Tilde Channel Last Cta View Data Tilde Channel
last_cta_view_data_tilde_creative_id TEXT Last Cta View Data Tilde Creative Id Last Cta View Data Tilde Creative Id
last_cta_view_data_tilde_creative_name TEXT Last Cta View Data Tilde Creative Name Last Cta View Data Tilde Creative Name
last_cta_view_data_tilde_feature TEXT Last Cta View Data Tilde Feature Last Cta View Data Tilde Feature
last_cta_view_data_tilde_secondary_publisher TEXT Last Cta View Data Tilde Secondary Publisher Last Cta View Data Tilde Secondary Publisher
last_cta_view_data_tilde_stage TEXT Last Cta View Data Tilde Stage Last Cta View Data Tilde Stage
last_cta_view_data_tilde_tags TEXT Last Cta View Data Tilde Tags Last Cta View Data Tilde Tags
lifecycle_event_achieve_level NUMERIC ACHIEVE_LEVEL ACHIEVE_LEVEL lifecycle event value
lifecycle_event_complete_registration NUMERIC COMPLETE_REGISTRATION COMPLETE_REGISTRATION lifecycle event value
lifecycle_event_complete_tutorial NUMERIC COMPLETE_TUTORIAL COMPLETE_TUTORIAL lifecycle event value
lifecycle_event_invite NUMERIC INVITE INVITE lifecycle event value
lifecycle_event_login NUMERIC LOGIN LOGIN lifecycle event value
lifecycle_event_start_trial NUMERIC START_TRIAL START_TRIAL lifecycle event value
lifecycle_event_subscribe NUMERIC SUBSCRIBE SUBSCRIBE lifecycle event value
lifecycle_event_unlock_achievement NUMERIC UNLOCK_ACHIEVEMENT UNLOCK_ACHIEVEMENT lifecycle event value
month TEXT Month Number of the month
now TIMESTAMP Now Current timestamp
source TEXT Source The name of the Windsor connector returning the row
today DATE Today Today's date
user_data_app_store TEXT User App Store App store on event
user_data_country COUNTRY User country User's country.
user_data_environment TEXT User environment User's environment.
user_data_geo_country_code TEXT User country code User's country code.

Branch fields (user_data_geo_dma_code to year_week_iso)

ID Type Name Description
user_data_geo_dma_code TEXT User DMA code User's geographical Designated Market Area code.
user_data_geo_region_en REGION User region User's region.
user_data_language TEXT User language User's language.
user_data_opted_in TEXT User opted in Is user opted in?
user_data_opted_in_status TEXT User opt-in status User's opt-in status.
user_data_os TEXT User OS User's operating system.
user_data_platform TEXT User platform User's platform.
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).
xx_click NUMERIC Clicks (SAN-inclusive) The number of clicks including SAN Ad Partners. Combined aggregated data source containing both Real-Time user-device level Branch Link clicks and self-attributing network (e.g. Facebook, Google, X, Snap, Apple Search Ads, TikTok) clicks.
xx_impression NUMERIC Impressions (SAN-inclusive) The number of ad impressions including SAN Ad Partners. Combined aggregated data source containing both Real-Time user-device level impressions/ad-views triggered via Impression Tracking Ad Links and self-attributing network (e.g. Facebook, Google, X, Snap, Apple Search Ads, TikTok) impressions.
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