Matomo

Matomo Heatmap Session Recording API

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. idSiteHsr identifies a heatmap or session recording configuration, while idLogHsr identifies an individual recorded activity entry.

GitHub OpenAPI

Operations 31

GET /index.php?module=API&method=HeatmapSessionRecording.addHeatmap Heatmap session recording add heatmap #
GET /index.php?module=API&method=HeatmapSessionRecording.duplicateHeatmap Heatmap session recording duplicate heatmap #
GET /index.php?module=API&method=HeatmapSessionRecording.updateHeatmap Heatmap session recording update heatmap #
GET /index.php?module=API&method=HeatmapSessionRecording.deleteHeatmapScreenshot Heatmap session recording delete heatmap screenshot #
GET /index.php?module=API&method=HeatmapSessionRecording.addSessionRecording Heatmap session recording add session recording #
GET /index.php?module=API&method=HeatmapSessionRecording.updateSessionRecording Heatmap session recording update session recording #
GET /index.php?module=API&method=HeatmapSessionRecording.getHeatmap Heatmap session recording get heatmap #
GET /index.php?module=API&method=HeatmapSessionRecording.getSessionRecording Heatmap session recording get session recording #
GET /index.php?module=API&method=HeatmapSessionRecording.pauseHeatmap Heatmap session recording pause heatmap #
GET /index.php?module=API&method=HeatmapSessionRecording.resumeHeatmap Heatmap session recording resume heatmap #
GET /index.php?module=API&method=HeatmapSessionRecording.deleteHeatmap Heatmap session recording delete heatmap #
GET /index.php?module=API&method=HeatmapSessionRecording.endHeatmap Heatmap session recording end heatmap #
GET /index.php?module=API&method=HeatmapSessionRecording.pauseSessionRecording Heatmap session recording pause session recording #
GET /index.php?module=API&method=HeatmapSessionRecording.resumeSessionRecording Heatmap session recording resume session recording #
GET /index.php?module=API&method=HeatmapSessionRecording.deleteSessionRecording Heatmap session recording delete session recording #
GET /index.php?module=API&method=HeatmapSessionRecording.endSessionRecording Heatmap session recording end session recording #
GET /index.php?module=API&method=HeatmapSessionRecording.getHeatmaps Heatmap session recording get heatmaps #
GET /index.php?module=API&method=HeatmapSessionRecording.getSessionRecordings Heatmap session recording get session recordings #
GET /index.php?module=API&method=HeatmapSessionRecording.getRecordedSessions Heatmap session recording get recorded sessions #
GET /index.php?module=API&method=HeatmapSessionRecording.getRecordedSession Heatmap session recording get recorded session #
GET /index.php?module=API&method=HeatmapSessionRecording.deleteRecordedSession Heatmap session recording delete recorded session #
GET /index.php?module=API&method=HeatmapSessionRecording.deleteRecordedPageview Heatmap session recording delete recorded pageview #
GET /index.php?module=API&method=HeatmapSessionRecording.getRecordedHeatmapMetadata Heatmap session recording get recorded heatmap metadata #
GET /index.php?module=API&method=HeatmapSessionRecording.getRecordedHeatmap Heatmap session recording get recorded heatmap #
GET /index.php?module=API&method=HeatmapSessionRecording.testUrlMatchPages Heatmap session recording test url match pages #
GET /index.php?module=API&method=HeatmapSessionRecording.getAvailableStatuses Heatmap session recording get available statuses #
GET /index.php?module=API&method=HeatmapSessionRecording.getAvailableTargetPageRules Heatmap session recording get available target page rules #
GET /index.php?module=API&method=HeatmapSessionRecording.getAvailableDeviceTypes Heatmap session recording get available device types #
GET /index.php?module=API&method=HeatmapSessionRecording.getAvailableHeatmapTypes Heatmap session recording get available heatmap types #
GET /index.php?module=API&method=HeatmapSessionRecording.getAvailableSessionRecordingSampleLimits Heatmap session recording get available session recording sample limits #
GET /index.php?module=API&method=HeatmapSessionRecording.getEventTypes Heatmap session recording get event types #

Documentation

📖
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

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/matomo/refs/heads/main/openapi/matomo-heatmapsessionrecording-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/matomo-heatmapsessionrecording-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

matomo-heatmapsessionrecording-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Matomo Reporting API for plugin Heatmap Session Recording…
  version: 1.0.0
  description: '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. idSiteHsr identifies a heatmap or session recording configuration, while idLogHsr identifies an individual recorded activity entry.'
servers:
- url: https://demo-proxy.innocraft.cloud/
  description: Current Matomo instance
security:
- MatomoToken: []
tags:


# --- truncated at 32 KB (60 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/matomo/refs/heads/main/openapi/matomo-heatmapsessionrecording-api-openapi.yml