DocsTools

Microsoft Clarity

Sessions, rage clicks and scroll depth.

Category
Analytics
How you connect
API key or token. You paste a key or token from the tool. Homla stores it encrypted and never shows it again.
Time to set up
About 2 minutes
Actions
3 read, 0 write

Connect it#

In Homla, open Connectors, then Microsoft Clarity. The Setup guide button walks you through the same steps, with fields to paste into.

Who can do it. An admin of the Clarity project. Only project admins can generate Data Export tokens.

  1. Open the Clarity projectPick the project of the website you want in Homla. One token covers one project: for several websites, repeat this guide and add one Homla account per project. Open it.
  2. Open the project's Settings, then Data exportIn the left menu of Settings, click Data export, then Generate new API token.
  3. Name the token Homla and generate itThe name must be 4 to 32 characters: letters, digits, hyphens, underscores or dots, no spaces, and unique in the project. There is nothing else to choose: every Data Export token is read-only.
  4. Copy the tokenCopy the long token Clarity shows (it starts with eyJ).

    Clarity shows the token only once. Paste it straight into Homla, never into a chat or an email. If you lose it, delete it and generate a new one.

  5. Paste it into HomlaIn Homla, open Connectors, then Microsoft Clarity, then Connect an account. Name the account after the website or client, paste the token into Clarity Data Export API token, and click Add account. Homla encrypts it and never shows it again. Open it.

What your AI can do#

These are the actions Homla gives your AI. Your role decides which ones you get. Write actions are a dry run until confirmed, see Approvals and dry runs.

Read#

Looks things up, never changes anything.

ActionWhat it does
clarity_insightsClarity metrics for the last 1-3 days (24/48/72h), split by up to 3 dimensions.
clarity_historyStored Clarity pulls over time (past Clarity's 3-day limit): one metric per pull for a date range, optionally filtered to one dimension value.
clarity_quotaClarity API calls Wedge made today for this project, calls left of 10, what is cached and how far back history goes.

Disconnect it#

In Homla, open the account menu on the tool's page and choose Disconnect. Anyone it was shared with loses access at once. To cut it off on the tool's side too:

To cut Homla off, open the project's Settings, then Data export, and delete the Homla token: it stops working at once. To rotate, generate a new token there and paste it into the same Homla account (Replace). Clarity also recommends replacing the token when someone with access leaves the project.

Generated from the product code. Action names are what the CLI and the API use.