Heatmaps - API Documentation
Enterprise
This feature is part of Countly Enterprise. To get access, contact sales or compare versions. Existing customers can reach the support portal with questions.
Overview
Heatmaps shows where users click and how far they scroll on the pages of a web app. These endpoints list the tracked views and domains and return summary totals for them. The interaction points of a single view are read with Views - Actions/Heatmap Read.
Endpoints
- Heatmaps - Views -
/o/heatmaps/views - Heatmaps - Domains -
/o/heatmaps/domains - Heatmaps - Metrics -
/o/heatmaps/metrics
Permissions & Access
All endpoints require Read permission on the heatmaps feature.
Implementation details
Database Collections
| Collection | Purpose |
|---|---|
countly.app_viewdata{sha1(segment+appId)} | Aggregated view metrics (visits and scroll values). |
countly.app_viewsmeta{appId} | Per-view metadata (name, display name, URL). |
countly.views | Segment map of the app. |
countly_drill.drill_events and countly_drill.drill_meta | Domain values of [CLY]_action events. |