Analytics

Microsoft Clarity

Record heatmaps and session replays on your documentation site with Microsoft Clarity.

Microsoft Clarity provides free heatmaps, session recordings, and behavioral insights. Enable the integration to understand how readers navigate your documentation.

Prerequisites

A Microsoft Clarity account with a project created
Your Clarity project ID
Publishing access to your documentation project

Configure from the Editor

Open Site Config

In the Editor, click Site Config in the top toolbar.

Navigate to Integrations

Select Integrations from the left sidebar.

Enable Clarity

Select Clarity and enter your project ID.

Publish

Click Publish to deploy the integration to your live site.

Configure via documentation.json

Add the clarity key under integrations in your documentation.json:

{
  "integrations": {
    "clarity": {
      "projectId": "your_project_id"
    }
  }
}

Property	Type	Required	Description
`projectId`	string	Yes	Your Clarity project ID

Where to find your project ID

Sign in to Microsoft Clarity.
Go to Settings → Overview.
Copy the Project ID value.

What's next

Analytics and Chat Integrations — overview of all supported integrations
Hotjar — heatmaps and session recordings with Hotjar
Analytics overview — view traffic and engagement data for your documentation

Was this page helpful?

Last updated 1 day ago

Built with Documentation.AI