# Matomo Heatmap Session Recording API

**Canonical:** https://apis.io/apis/matomo/matomo-heatmapsessionrecording-api/  
**Provider:** Matomo — https://apis.io/providers/matomo/  
**Base URL:** https://{matomo_host}/index.php  
**Documentation:** https://developer.matomo.org/api-reference/reporting-api

Matomo Heatmap Session Recording API is one of 61 APIs that [Matomo](https://apis.io/providers/matomo/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include HeatmapSessionRecording. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

Exposes the Heatmap & Session Recording API endpoints for managing configurations and retrieving recorded activity. Heatmap coordinates use relative values: X and Y positions range from 0 to 2000, where 1000 represents 50% of the matched element. Scroll reach and above-the-fold positions range from 0 to 1000, where 100 represents 10% of the page height. <code>idSiteHsr</code> identifies a heatmap or session recording configuration, while <code>idLogHsr</code> identifies an individual recorded activity entry.

## Operations (31)

| Method | Path | Summary |
|---|---|---|
| GET | `/index.php?module=API&method=HeatmapSessionRecording.addHeatmap` | — |
| GET | `/index.php?module=API&method=HeatmapSessionRecording.duplicateHeatmap` | — |
| GET | `/index.php?module=API&method=HeatmapSessionRecording.updateHeatmap` | — |
| GET | `/index.php?module=API&method=HeatmapSessionRecording.deleteHeatmapScreenshot` | — |
| GET | `/index.php?module=API&method=HeatmapSessionRecording.addSessionRecording` | — |
| GET | `/index.php?module=API&method=HeatmapSessionRecording.updateSessionRecording` | — |
| GET | `/index.php?module=API&method=HeatmapSessionRecording.getHeatmap` | — |
| GET | `/index.php?module=API&method=HeatmapSessionRecording.getSessionRecording` | — |
| GET | `/index.php?module=API&method=HeatmapSessionRecording.pauseHeatmap` | — |
| GET | `/index.php?module=API&method=HeatmapSessionRecording.resumeHeatmap` | — |
| GET | `/index.php?module=API&method=HeatmapSessionRecording.deleteHeatmap` | — |
| GET | `/index.php?module=API&method=HeatmapSessionRecording.endHeatmap` | — |
| GET | `/index.php?module=API&method=HeatmapSessionRecording.pauseSessionRecording` | — |
| GET | `/index.php?module=API&method=HeatmapSessionRecording.resumeSessionRecording` | — |
| GET | `/index.php?module=API&method=HeatmapSessionRecording.deleteSessionRecording` | — |
| GET | `/index.php?module=API&method=HeatmapSessionRecording.endSessionRecording` | — |
| GET | `/index.php?module=API&method=HeatmapSessionRecording.getHeatmaps` | — |
| GET | `/index.php?module=API&method=HeatmapSessionRecording.getSessionRecordings` | — |
| GET | `/index.php?module=API&method=HeatmapSessionRecording.getRecordedSessions` | — |
| GET | `/index.php?module=API&method=HeatmapSessionRecording.getRecordedSession` | — |
| GET | `/index.php?module=API&method=HeatmapSessionRecording.deleteRecordedSession` | — |
| GET | `/index.php?module=API&method=HeatmapSessionRecording.deleteRecordedPageview` | — |
| GET | `/index.php?module=API&method=HeatmapSessionRecording.getRecordedHeatmapMetadata` | — |
| GET | `/index.php?module=API&method=HeatmapSessionRecording.getRecordedHeatmap` | — |
| GET | `/index.php?module=API&method=HeatmapSessionRecording.testUrlMatchPages` | — |
| GET | `/index.php?module=API&method=HeatmapSessionRecording.getAvailableStatuses` | — |
| GET | `/index.php?module=API&method=HeatmapSessionRecording.getAvailableTargetPageRules` | — |
| GET | `/index.php?module=API&method=HeatmapSessionRecording.getAvailableDeviceTypes` | — |
| GET | `/index.php?module=API&method=HeatmapSessionRecording.getAvailableHeatmapTypes` | — |
| GET | `/index.php?module=API&method=HeatmapSessionRecording.getAvailableSessionRecordingSampleLimits` | — |
| GET | `/index.php?module=API&method=HeatmapSessionRecording.getEventTypes` | — |

## Machine-readable artifacts (5)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/matomo/refs/heads/main/openapi/matomo-heatmapsessionrecording-api-openapi.yml
- **Documentation** — https://developer.matomo.org/api-reference/reporting-api
- **Documentation** — https://developer.matomo.org/api-reference/reporting-api#Live
- **Documentation** — https://developer.matomo.org/api-reference/reporting-api#Goals
- **Documentation** — https://developer.matomo.org/api-reference/reporting-api-segmentation

## Other Matomo APIs (12)

- [Matomo Reporting API (index.php entrypoint)](https://apis.io/apis/matomo/matomo-index-php-api/)
- [Matomo Tracking API (matomo.php entrypoint)](https://apis.io/apis/matomo/matomo-matomo-php-api/)
- [Matomo Ab Testing API](https://apis.io/apis/matomo/matomo-abtesting-api/)
- [Matomo Actions API](https://apis.io/apis/matomo/matomo-actions-api/)
- [Matomo Activity Log API](https://apis.io/apis/matomo/matomo-activitylog-api/)
- [Matomo Advertising Conversion Export API](https://apis.io/apis/matomo/matomo-advertisingconversionexport-api/)
- [Matomo Annotations API](https://apis.io/apis/matomo/matomo-annotations-api/)
- [Matomo API](https://apis.io/apis/matomo/matomo-api-api/)
- [Matomo API Reference API](https://apis.io/apis/matomo/matomo-apireference-api/)
- [Matomo Bandwidth API](https://apis.io/apis/matomo/matomo-bandwidth-api/)
- [Matomo Cohorts API](https://apis.io/apis/matomo/matomo-cohorts-api/)
- [Matomo Contents API](https://apis.io/apis/matomo/matomo-contents-api/)

## Tags

HeatmapSessionRecording

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/matomo/matomo-heatmapsessionrecording-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/matomo/.