Microsoft Clarity

Overview

Microsoft Clarity provides heatmaps, session recordings, and engagement metrics in the product. The SquadOS integration, however, exposes only the aggregated Data Export API: the agent can query metrics split by operating system, device, browser, and other dimensions, but it does not receive heatmaps or session videos.

• 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.

Use a dedicated token and enter it only on the secure page hosted by Composio. Do not put the token in prompts, messages, or knowledge bases. Replace it promptly if an administrator with access leaves the project or exposure is suspected.

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. Open the Configure tool panel and click Activate. The integration moves to Active with the Awaiting authentication state.
4. Open the active tool and click Connect now.
5. Enter the token on the secure page hosted by Composio and complete the connection.
6. Back in SquadOS, confirm the account under Accounts and use Edit actions to review the available operation.
7. In the agent editor, open Tools, click Add Tool, choose Microsoft Clarity, select the account and action, save, and run a controlled test. (See Organization Tools for the complete flow.)

Available actions

The current Composio catalog contains 1 Microsoft Clarity action; its identifier is documented below. Parameters come from snapshot 20260407_00, while the current catalog is on 20260724_00. Confirm the schema under Edit actions before saving.

Caution

The API limits each project to 10 requests per day, queries only the previous 1, 2, or 3 days, accepts up to three dimensions, and returns at most 1,000 rows with no pagination. Plan each export, avoid automatic repetition, and treat 429 as a daily limit rather than a reason for aggressive retries. Metrics are aggregated but may still reveal sensitive patterns; apply the organization’s privacy and retention policy.

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.