Microsoft Clarity

Overview

Microsoft Clarity is a free user behavior analytics tool that captures heatmaps, session recordings, and engagement metrics to help improve website experiences. With the integration in SquadOS, your agents can export Clarity analytics data — segmented by operating system, device, browser, and more — for automated reports, funnel analysis, and decisions based on real user behavior.

• Official website: https://clarity.microsoft.com/
• Composio documentation: docs.composio.dev/toolkits/microsoft_clarity

Authentication

This tool uses an API key (API_KEY) to connect.

You will need the following fields:

Field	Required	Description
api_key	Yes	Access token generated in your Clarity project settings (Settings → Data Export → Generate new API token).

How to get credentials

1. Go to clarity.microsoft.com and sign in with your Microsoft account.
2. Select the desired project from the main dashboard.
3. Go to Settings in the project menu.
4. Click the Data Export tab.
5. Click Generate new API token, set a descriptive name (4–32 characters), and confirm.
6. Copy the generated token — this is the value to use in the api_key field when connecting in SquadOS.

Tip

Only project admins can create and manage access tokens. If you don’t see the Data Export tab, ask the project owner to grant you admin access.

How to connect in SquadOS

1. Go to Tools in the side menu (/admin/tools).
2. Open the Available tab and search for Microsoft Clarity.
3. Click the card to open the details and hit Connect.
4. You’re taken to the secure connection page hosted by Composio, where you enter the API token obtained above.
5. Once done, you’re sent back to SquadOS with the account connected and the tool available to agents. (Connection-flow details in Organization Tools.)

Available actions

Data Export

MICROSOFT_CLARITY_DATA_EXPORT

Export data from Microsoft Clarity. Retrieves user behavior insights segmented by up to three dimensions (e.g., OS, device, browser), covering the last 24, 48, or 72 hours.

Input parameters

Name	Type	Required	Description
numOfDays	integer	Yes	The number of days for the data export since the API call, relating to the last 24, 48, or 72 hours, respectively.
dimension1	string	No	The first dimension to break down insights.
dimension2	string	No	The second dimension to break down insights.
dimension3	string	No	The third dimension to break down insights.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error message if execution failed.
successful	boolean	Yes	Whether the action executed successfully.