Microsoft clarity | Composio Docs

Overview

SLUG: MICROSOFT_CLARITY

Description

Microsoft Clarity is a free user behavior analytics tool that captures heatmaps, session recordings, and engagement metrics to help improve website experiences

Authentication Details

Bearer Token

token

stringRequired

bearer_token

stringRequired

Connecting to Microsoft clarity

Create an auth config

Use the dashboard to create an auth config for the Microsoft clarity toolkit. This allows you to connect multiple Microsoft clarity accounts to Composio for agents to use.

Select App

Navigate to [Microsoft clarity](https://platform.composio.dev/marketplace/Microsoft clarity).

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

Create and Get auth config ID

Click “Create Microsoft clarity Auth Config”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using Bearer Token

1 from composio import Composio
2 
3 # Auth config ID created above
4 microsoft_clarity_auth_config_id = "ac_YOUR_MICROSOFT_CLARITY_CONFIG_ID" 
5 
6 # UUID from database/application
7 user_id = "0000-0000-0000"
8 
9 composio = Composio()
10 
11 
12 def authenticate_toolkit(user_id: str, auth_config_id: str):
13     # Replace this with a method to retrieve the Bearer Token from the user.
14     bearer_token = input("[!] Enter bearer token")
15     connection_request = composio.connected_accounts.initiate(
16         user_id=user_id,
17         auth_config_id=auth_config_id,
18         config={"auth_scheme": "BEARER_TOKEN", "val": bearer_token}
19     )
20     print(f"Successfully connected Microsoft clarity for user {user_id}")
21     print(f"Connection status: {connection_request.status}")
22     
23     return connection_request.id
24 
25 
26 connection_id = authenticate_toolkit(user_id, microsoft_clarity_auth_config_id)
27 
28 # You can verify the connection using:
29 connected_account = composio.connected_accounts.get(connection_id)
30 print(f"Connected account: {connected_account}")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the [Microsoft clarity toolkit’s playground](https://app.composio.dev/app/Microsoft clarity)

OpenAI (Python)

Anthropic (TypeScript)

Google (Python)

Vercel (TypeScript)

Python

1 from composio import Composio
2 from openai import OpenAI
3 import json
4 
5 openai = OpenAI()
6 composio = Composio()
7 
8 # User ID must be a valid UUID format
9 user_id = "0000-0000-0000"  # Replace with actual user UUID from your database
10 
11 tools = composio.tools.get(user_id=user_id, toolkits=["MICROSOFT_CLARITY"])
12 
13 print("[!] Tools:")
14 print(json.dumps(tools))
15 
16 def invoke_llm(task = "What can you do?"):
17     completion = openai.chat.completions.create(
18         model="gpt-4o",
19         messages=[
20             {
21                 "role": "user",
22                 "content": task,  # Your task here!
23             },
24         ],
25         tools=tools,
26     )
27 
28     # Handle Result from tool call
29     result = composio.provider.handle_tool_calls(user_id=user_id, response=completion)
30     print(f"[!] Completion: {completion}")
31     print(f"[!] Tool call result: {result}")
32 
33 invoke_llm()

Tool List

MICROSOFT_CLARITY_DATA_EXPORT

Tool Name: Data Export

Description

Export data from microsoft clarity.

Action Parameters

dimension1

string

dimension2

string

dimension3

string

numOfDays

integerRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired