Microsoft Clarity
The Microsoft Clarity connector imports user behavior data — session recordings, heatmap insights, rage clicks, and dead clicks. Unlike other connectors, Clarity uses an API key rather than OAuth and provides qualitative behavior data that complements quantitative metrics.
Authentication
Clarity uses API key authentication via the Data Export API.
Get your Clarity API token
In your Microsoft Clarity project, go to Settings > Data Export API and generate an API token.
Enter the token in Apex
On the Sensors page, find the Microsoft Clarity card, click Connect, and paste your API token.
Verify the connection
Apex validates the token format and confirms connectivity on the first sync.
Info
Clarity's Data Export API has a rate limit of 10 requests per day per project. Apex schedules syncs accordingly and caches results between syncs.
Data Synced
Each sync pulls live insights from the last 3 days:
| Metric | Description |
|---|---|
| Sessions | Total session count across devices |
| Users | Distinct user count |
| Rage clicks | Clicks where a user rapidly clicked the same area (frustration signal) |
| Dead clicks | Clicks on elements that didn't respond (broken UI signal) |
| Script errors | JavaScript errors captured during sessions |
| Traffic by device | Session breakdown by device type |
| UX by URL | Engagement metrics broken down by page URL |
How Apex Uses This Data
- Frustration detection — Rage clicks and dead clicks highlight UX problems that may be hurting your experiment results
- Experiment debugging — If a variant is underperforming, Clarity data can reveal why — users might be confused by new UI elements
- Session context — Understand how users actually interact with your pages, beyond click and conversion counts
- Quality signals — Script errors and dead clicks feed into overall site health monitoring
Tip
Pair Clarity's qualitative data with your experiment results for a complete picture. A variant might have higher conversion but also higher rage clicks — which could indicate a dark pattern rather than genuine improvement.
Configuration
| Parameter | Type | Description |
|---|---|---|
api_keyrequired | string | Microsoft Clarity Data Export API token. Generated in Clarity Settings > Data Export API. |
Differences from Other Connectors
| Feature | Clarity | Other Connectors |
|---|---|---|
| Auth method | API key | OAuth 2.0 |
| Data type | Qualitative (behavior) | Quantitative (metrics) |
| Refresh cycle | 3-day rolling window | Configurable date range |
| Rate limit | 10 requests/day | Varies by platform |
Troubleshooting
| Issue | Cause | Fix |
|---|---|---|
| "Invalid token" | Token is too short or malformed | Regenerate the token in Clarity Settings |
| All metrics show 0 | Clarity tracking code not installed | Add the Clarity JavaScript snippet to your website |
| Sync fails silently | API rate limit exceeded | Wait until the next day — the 10/day limit resets at midnight UTC |
Next Steps
- View your dashboard to see Clarity data alongside other metrics
- Run an experiment and use Clarity recordings to evaluate variant quality