Microsoft Clarity API Documentation
This is the complete API documentation for connecting to the Microsoft Clarity API using MindCloud's Universal API. If you are new to MindCloud, start with the Introduction to see how one API can sit in front of many different apps.
MindCloud is an integration company that offers one normalized API to access 3,100+ apps from a single place. It cleans up provider-specific quirks, keeps requests and responses consistent, and centralizes authentication so you do not need to manage separate flows for every app. Browse other apps.
Meet Microsoft Clarity: Export recent Microsoft Clarity dashboard insights for traffic, engagement, devices, browsers, URLs, and campaigns. Keep reading to get started.
Quickstart
Before you run your first Microsoft Clarity request, you need three things:
- A MindCloud account — sign in or create an account at MindCloud.
- A MindCloud API Key — create one in API Keys. Keep it on your server.
- At least one Microsoft Clarity connection — create or choose one in Connections. Note its
connectionId.
Every Microsoft Clarity action uses the same URL pattern:
POST https://connect.mindcloud.co/v2/universal/apps/microsoftClarity/actions/{actionSlug}/runYou need a MindCloud API Key and a Microsoft Clarity connection. Then call an action such as Get Project Live Insights:
curl --request POST \
--url "https://connect.mindcloud.co/v2/universal/apps/microsoftClarity/actions/get-project-live-insights/run" \
--header "Authorization: Bearer $MINDCLOUD_API_KEY" \
--header "Content-Type: application/json" \
--data '{
"connectionId": "$CONNECTION_ID",
"arguments": {}
}'Every response comes back in the same envelope, with your rows in a data array:
{
"success": true,
"data": [
{ "id": "1042", "name": "Ava" }
],
"meta": {}
}After your first request works, use Shape your requests to control arguments, pagination, filtering, fields, and errors.
Authenticate with a MindCloud API Key plus a connectionId for your Microsoft Clarity account. See Microsoft Clarity API Authentication for the full flow and how to get your connection credentials.
Microsoft Clarity actions
All 1 published action for this Microsoft Clarity version. Each page documents the endpoint, arguments, and response controls.
Related apps
More Business Intelligence apps on the Universal API, behind the same REST shape. Or browse all apps.