Microsoft Clarity Connector Reference

38 metrics32 dimensions

Fields

The Microsoft Clarity connector exposes 70 fields (38 metrics, 32 dimensions). Every field ID below can be passed to the Windsor.ai API in the fields parameter.

Microsoft Clarity Fields

Microsoft Clarity Insights fields

The Insights report of the Microsoft Clarity connector includes 51 fields.

Microsoft Clarity Insights fields (active_time to rage_click_sub_total)

ID	Type	Name	Description
active_time	NUMERIC	Active Time	The active engagement time reported in the EngagementTime metric block.
average_scroll_depth	PERCENT	Average Scroll Depth	The average scroll depth percentage reported in the ScrollDepth metric block.
browser	TEXT	Browser	The browser used by the visitor.
campaign	TEXT	Campaign	The traffic campaign that drove the visitor.
channel	TEXT	Channel	The traffic channel of the visitor.
country	COUNTRY	Country	The country or region of the visitor.
date	DATE	Date	The end date of the requested period. Clarity returns aggregated data for the last 1 to 3 days, so this value is the same for every row in a single query.
dead_click_pages_views	NUMERIC	Dead Click Pages Views	The number of page views recorded in the DeadClickCount metric block.
dead_click_sessions_count	NUMERIC	Dead Click Sessions Count	The number of sessions in the DeadClickCount metric block.
dead_click_sessions_with_metric_percentage	PERCENT	Dead Click Sessions With Metric Percentage	The percentage of sessions in which a dead click fired.
dead_click_sessions_without_metric_percentage	PERCENT	Dead Click Sessions Without Metric Percentage	The percentage of sessions in which a dead click did not fire.
dead_click_sub_total	NUMERIC	Dead Click Sub Total	The subtotal reported in the DeadClickCount metric block.
device	TEXT	Device	The device type (e.g., desktop, mobile) used by the visitor.
distinct_user_count	NUMERIC	Distinct User Count	The number of distinct users in the Traffic metric block.
error_click_pages_views	NUMERIC	Error Click Pages Views	The number of page views recorded in the ErrorClickCount metric block.
error_click_sessions_count	NUMERIC	Error Click Sessions Count	The number of sessions in the ErrorClickCount metric block.
error_click_sessions_with_metric_percentage	PERCENT	Error Click Sessions With Metric Percentage	The percentage of sessions in which an error click fired.
error_click_sessions_without_metric_percentage	PERCENT	Error Click Sessions Without Metric Percentage	The percentage of sessions in which an error click did not fire.
error_click_sub_total	NUMERIC	Error Click Sub Total	The subtotal reported in the ErrorClickCount metric block.
excessive_scroll_pages_views	NUMERIC	Excessive Scroll Pages Views	The number of page views recorded in the ExcessiveScroll metric block.
excessive_scroll_sessions_count	NUMERIC	Excessive Scroll Sessions Count	The number of sessions in the ExcessiveScroll metric block.
excessive_scroll_sessions_with_metric_percentage	PERCENT	Excessive Scroll Sessions With Metric Percentage	The percentage of sessions in which excessive scrolling fired.
excessive_scroll_sessions_without_metric_percentage	PERCENT	Excessive Scroll Sessions Without Metric Percentage	The percentage of sessions in which excessive scrolling did not fire.
excessive_scroll_sub_total	NUMERIC	Excessive Scroll Sub Total	The subtotal reported in the ExcessiveScroll metric block.
medium	TEXT	Medium	The traffic medium of the visitor.
metric_type	TEXT	Clarity Metric Type	The Clarity metric block the row originates from (Traffic, ScrollDepth, EngagementTime, DeadClickCount, ExcessiveScroll, RageClickCount, QuickbackClick, ScriptErrorCount, or ErrorClickCount).
num_days	NUMERIC	Clarity Number Of Days	The numOfDays value (1, 2, or 3) used for the request. Distinguishes a 'last 1 day' query from a 'last 2 days' query when both share the same date_to.
os	TEXT	Operating System	The operating system of the visitor.
pages_per_session_percentage	PERCENT	Pages Per Session Percentage	The pages per session value reported in the Traffic metric block.
pagetitle	TEXT	Page Title	The page title (returned for the Popular Pages metric block).
quickback_click_pages_views	NUMERIC	Quickback Click Pages Views	The number of page views recorded in the QuickbackClick metric block.
quickback_click_sessions_count	NUMERIC	Quickback Click Sessions Count	The number of sessions in the QuickbackClick metric block.
quickback_click_sessions_with_metric_percentage	PERCENT	Quickback Click Sessions With Metric Percentage	The percentage of sessions in which a quickback click fired.
quickback_click_sessions_without_metric_percentage	PERCENT	Quickback Click Sessions Without Metric Percentage	The percentage of sessions in which a quickback click did not fire.
quickback_click_sub_total	NUMERIC	Quickback Click Sub Total	The subtotal reported in the QuickbackClick metric block.
rage_click_pages_views	NUMERIC	Rage Click Pages Views	The number of page views recorded in the RageClickCount metric block.
rage_click_sessions_count	NUMERIC	Rage Click Sessions Count	The number of sessions in the RageClickCount metric block.
rage_click_sessions_with_metric_percentage	PERCENT	Rage Click Sessions With Metric Percentage	The percentage of sessions in which a rage click fired.
rage_click_sessions_without_metric_percentage	PERCENT	Rage Click Sessions Without Metric Percentage	The percentage of sessions in which a rage click did not fire.
rage_click_sub_total	NUMERIC	Rage Click Sub Total	The subtotal reported in the RageClickCount metric block.

Microsoft Clarity Insights fields (referrer_url to url)

ID	Type	Name	Description
referrer_url	TEXT	Referrer URL	The referrer URL (returned for the Popular Pages metric block).
script_error_pages_views	NUMERIC	Script Error Pages Views	The number of page views recorded in the ScriptErrorCount metric block.
script_error_sessions_count	NUMERIC	Script Error Sessions Count	The number of sessions in the ScriptErrorCount metric block.
script_error_sessions_with_metric_percentage	PERCENT	Script Error Sessions With Metric Percentage	The percentage of sessions in which a script error fired.
script_error_sessions_without_metric_percentage	PERCENT	Script Error Sessions Without Metric Percentage	The percentage of sessions in which a script error did not fire.
script_error_sub_total	NUMERIC	Script Error Sub Total	The subtotal reported in the ScriptErrorCount metric block.
source	TEXT	Source	The traffic source of the visitor.
total_bot_session_count	NUMERIC	Total Bot Session Count	The total number of bot sessions in the Traffic metric block.
total_session_count	NUMERIC	Total Session Count	The total number of sessions in the Traffic metric block.
total_time	NUMERIC	Total Time	The total engagement time reported in the EngagementTime metric block.
url	TEXT	URL	The URL the visitor interacted with.

Microsoft Clarity other fields

The Microsoft Clarity connector has 19 fields that do not belong to a named report, or belong to a report with only one or two fields.

ID	Type	Name	Description
account_id	TEXT	Account ID	The internal ID of the Microsoft Clarity account.
account_name	TEXT	Account Name	The name of the Microsoft Clarity account.
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
day_of_month	TEXT	Day of month	Day of the month
month	TEXT	Month	Number of the month
now	TIMESTAMP	Now	Current timestamp
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