Analytics

Hotjar

Understand user behavior on your documentation site with Hotjar heatmaps and session recordings.

Hotjar captures heatmaps, session recordings, and user feedback so you can see how readers interact with your documentation pages. Enable the integration to connect your Hotjar account.

Prerequisites

A Hotjar account with a site configured
Your Hotjar site 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 Hotjar

Select Hotjar and enter your site ID. Optionally update the snippet version if you use a version other than 6.

Publish

Click Publish to deploy the integration to your live site.

Configure via documentation.json

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

{
  "integrations": {
    "hotjar": {
      "hjid": "1234567",
      "hjsv": "6"
    }
  }
}

Property	Type	Required	Description
`hjid`	string	Yes	Your Hotjar site ID
`hjsv`	string	No	Hotjar snippet version (defaults to `6`)

Where to find your site ID

Sign in to Hotjar.
Go to Sites → Tracking Code.
Copy the site ID from the tracking code snippet (the numeric value in the script).

What's next

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

Was this page helpful?

Last updated 1 day ago

Built with Documentation.AI