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

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /index.php?module=API&method=HeatmapSessionRecording.addHeatmap Create a new heatmap · Heatmap session recording add heatmap #
Ask an LLM
“How do I start collecting a click heatmap for a landing page?”
“Can I limit how many page views a new heatmap samples?”
Tell an agent
Create a heatmap named {name} on site {idSite} for pages matching {matchPageRules}.
Add heatmap {name} to site {idSite} matching {matchPageRules} with a sample limit of {sampleLimit}.
GET /index.php?module=API&method=HeatmapSessionRecording.duplicateHeatmap Copy a heatmap to other sites · Heatmap session recording duplicate heatmap #
Ask an LLM
“Can I reuse an existing heatmap setup on my other websites?”
“What happens if I copy a heatmap to a site that already has one with that name?”
Tell an agent
Copy heatmap {idSiteHsr} from site {idSite} to sites {idDestinationSites}.
Duplicate heatmap {idSiteHsr} on site {idSite}.
GET /index.php?module=API&method=HeatmapSessionRecording.updateHeatmap Change an existing heatmap's settings · Heatmap session recording update heatmap #
Ask an LLM
“How do I change the page rules on a heatmap I already set up?”
“Can I adjust the sample rate of a running heatmap?”
Tell an agent
Update heatmap {idSiteHsr} on site {idSite}: rename it {name} and match {matchPageRules}.
Change the sample rate of heatmap {idSiteHsr} on site {idSite} to {sampleRate}, keeping name {name} and rules {matchPageRules}.
GET /index.php?module=API&method=HeatmapSessionRecording.deleteHeatmapScreenshot Delete a heatmap's stored screenshot · Heatmap session recording delete heatmap screenshot #
Ask an LLM
“How do I force a fresh screenshot for a heatmap after a page redesign?”
“Can I clear the saved page snapshot behind a heatmap?”
Tell an agent destructive · confirm first
Delete the stored screenshot for heatmap {idSiteHsr} on site {idSite}.
Remove the snapshot of heatmap {idSiteHsr} on site {idSite} so it is captured again.
GET /index.php?module=API&method=HeatmapSessionRecording.addSessionRecording Create a new session recording · Heatmap session recording add session recording #
Ask an LLM
“How do I start recording visitor sessions on my site?”
“Can I only record sessions that last longer than a minimum time?”
Tell an agent
Create a session recording named {name} on site {idSite}.
Add session recording {name} on site {idSite} that only keeps sessions longer than {minSessionTime} seconds.
GET /index.php?module=API&method=HeatmapSessionRecording.updateSessionRecording Change an existing session recording · Heatmap session recording update session recording #
Ask an LLM
“Can I turn keystroke capture on or off for a session recording I already created?”
“How do I edit the sampling of a session recording?”
Tell an agent
Update session recording {idSiteHsr} on site {idSite} and rename it {name}.
Set keystroke capture to {captureKeystrokes} on session recording {idSiteHsr} for site {idSite}, keeping name {name}.
GET /index.php?module=API&method=HeatmapSessionRecording.getHeatmap Get one heatmap's configuration · Heatmap session recording get heatmap #
Ask an LLM
“What page rules and sampling is a particular heatmap using?”
“Can I look up the settings of a single heatmap by its ID?”
Tell an agent
Show the configuration of heatmap {idSiteHsr} on site {idSite}.
Get heatmap {idSiteHsr} settings for site {idSite}.
GET /index.php?module=API&method=HeatmapSessionRecording.getSessionRecording Get one session recording's configuration · Heatmap session recording get session recording #
Ask an LLM
“What settings is a specific session recording configured with?”
“Does this session recording capture keystrokes?”
Tell an agent
Show the configuration of session recording {idSiteHsr} on site {idSite}.
Get session recording {idSiteHsr} settings for site {idSite}.
GET /index.php?module=API&method=HeatmapSessionRecording.pauseHeatmap Pause a heatmap · Heatmap session recording pause heatmap #
Ask an LLM
“Can I temporarily stop a heatmap from collecting data?”
“How do I put a heatmap on hold without ending it?”
Tell an agent
Pause heatmap {idSiteHsr} on site {idSite}.
Temporarily stop collecting data for heatmap {idSiteHsr} on site {idSite}.
GET /index.php?module=API&method=HeatmapSessionRecording.resumeHeatmap Resume a paused heatmap · Heatmap session recording resume heatmap #
Ask an LLM
“How do I restart data collection on a heatmap I paused?”
“Can a paused heatmap pick up collecting again?”
Tell an agent
Resume heatmap {idSiteHsr} on site {idSite}.
Restart collection on paused heatmap {idSiteHsr} for site {idSite}.
GET /index.php?module=API&method=HeatmapSessionRecording.deleteHeatmap Delete a heatmap · Heatmap session recording delete heatmap #
Ask an LLM
“How do I permanently remove a heatmap I no longer need?”
“Can I delete a heatmap configuration entirely?”
Tell an agent destructive · confirm first
Delete heatmap {idSiteHsr} on site {idSite}.
Remove heatmap configuration {idSiteHsr} from site {idSite}.
GET /index.php?module=API&method=HeatmapSessionRecording.endHeatmap End a heatmap · Heatmap session recording end heatmap #
Ask an LLM
“How do I finish a heatmap so it stops collecting for good but keeps its data?”
“Can I mark a heatmap as ended?”
Tell an agent destructive · confirm first
End heatmap {idSiteHsr} on site {idSite}.
Finish data collection for heatmap {idSiteHsr} on site {idSite}.
GET /index.php?module=API&method=HeatmapSessionRecording.pauseSessionRecording Pause a session recording · Heatmap session recording pause session recording #
Ask an LLM
“Can I temporarily stop recording sessions without deleting the setup?”
“How do I put session recording on hold?”
Tell an agent
Pause session recording {idSiteHsr} on site {idSite}.
Temporarily stop recording sessions for {idSiteHsr} on site {idSite}.
GET /index.php?module=API&method=HeatmapSessionRecording.resumeSessionRecording Resume a paused session recording · Heatmap session recording resume session recording #
Ask an LLM
“How do I start recording sessions again after pausing?”
“Can a paused session recording continue collecting?”
Tell an agent
Resume session recording {idSiteHsr} on site {idSite}.
Restart paused session recording {idSiteHsr} for site {idSite}.
GET /index.php?module=API&method=HeatmapSessionRecording.deleteSessionRecording Delete a session recording · Heatmap session recording delete session recording #
Ask an LLM
“How do I permanently remove a session recording configuration?”
“Can I delete a session recording setup I no longer use?”
Tell an agent destructive · confirm first
Delete session recording {idSiteHsr} on site {idSite}.
Remove session recording configuration {idSiteHsr} from site {idSite}.
GET /index.php?module=API&method=HeatmapSessionRecording.endSessionRecording End a session recording · Heatmap session recording end session recording #
Ask an LLM
“How do I finish a session recording so it stops capturing new sessions?”
“Can I mark a session recording as ended?”
Tell an agent destructive · confirm first
End session recording {idSiteHsr} on site {idSite}.
Finish capturing for session recording {idSiteHsr} on site {idSite}.
GET /index.php?module=API&method=HeatmapSessionRecording.getHeatmaps List all heatmaps for a site · Heatmap session recording get heatmaps #
Ask an LLM
“What heatmaps are set up on my website?”
“Can I list every heatmap on a site that hasn't been deleted?”
Tell an agent
List all heatmaps on site {idSite}.
Show every active or ended heatmap configured for site {idSite}.
GET /index.php?module=API&method=HeatmapSessionRecording.getSessionRecordings List all session recordings for a site · Heatmap session recording get session recordings #
Ask an LLM
“Which session recordings are configured on my website?”
“Can I see every session recording setup that hasn't been deleted?”
Tell an agent
List all session recordings on site {idSite}.
Show every session recording configured for site {idSite}.
GET /index.php?module=API&method=HeatmapSessionRecording.getRecordedSessions List sessions captured by a recording · Heatmap session recording get recorded sessions #
Ask an LLM
“Which visitor sessions were captured by a specific session recording last week?”
“How many sessions did my recording collect in a period?”
Tell an agent
List recorded sessions for session recording {idSiteHsr} on site {idSite} for {period} {date}.
Show sessions captured by recording {idSiteHsr} on site {idSite} in {period} {date}.
GET /index.php?module=API&method=HeatmapSessionRecording.getRecordedSession Replay one recorded session's activity · Heatmap session recording get recorded session #
Ask an LLM
“Can I get the full activity of a single recorded visitor session to replay it?”
“What did the visitor do in one specific recorded session?”
Tell an agent
Get all activity for recorded session {idLogHsr} in recording {idSiteHsr} on site {idSite}.
Load recorded session {idLogHsr} from recording {idSiteHsr} for replay on site {idSite}.
GET /index.php?module=API&method=HeatmapSessionRecording.deleteRecordedSession Delete a whole recorded session · Heatmap session recording delete recorded session #
Ask an LLM
“How do I delete everything recorded for one visit?”
“Can I remove a recorded visitor session for privacy reasons?”
Tell an agent destructive · confirm first
Delete all recorded page views for visit {idVisit} in recording {idSiteHsr} on site {idSite}.
Remove recorded session for visit {idVisit} from recording {idSiteHsr} on site {idSite}.
GET /index.php?module=API&method=HeatmapSessionRecording.deleteRecordedPageview Delete one page view from a recording · Heatmap session recording delete recorded pageview #
Ask an LLM
“Can I delete just one page view from a recorded session?”
“How do I remove a single recorded page from a session replay?”
Tell an agent destructive · confirm first
Delete recorded page view {idLogHsr} from recording {idSiteHsr} on site {idSite}.
Remove only page view {idLogHsr} from recording {idSiteHsr} on site {idSite}.
GET /index.php?module=API&method=HeatmapSessionRecording.getRecordedHeatmapMetadata Get summary metadata for a heatmap · Heatmap session recording get recorded heatmap metadata #
Ask an LLM
“How many page views has my heatmap collected so far?”
“What summary stats are available for a recorded heatmap?”
Tell an agent
Get summary metadata for heatmap {idSiteHsr} on site {idSite} for {period} {date}.
Show how much data heatmap {idSiteHsr} recorded on site {idSite} in {period} {date}.
GET /index.php?module=API&method=HeatmapSessionRecording.getRecordedHeatmap Get the recorded heatmap activity data · Heatmap session recording get recorded heatmap #
Ask an LLM
“Where are visitors clicking on my page on mobile devices?”
“Can I pull the raw click or scroll heatmap data for a device type?”
Tell an agent
Get {heatmapType} heatmap data for heatmap {idSiteHsr} on site {idSite}, device type {deviceType}, for {period} {date}.
Fetch the recorded heatmap activity for {idSiteHsr} on site {idSite} for {deviceType} devices, type {heatmapType}, {period} {date}.
GET /index.php?module=API&method=HeatmapSessionRecording.testUrlMatchPages Test whether a URL matches page rules · Heatmap session recording test url match pages #
Ask an LLM
“Will my heatmap page rules actually match this URL?”
“How can I check a target page rule before saving it?”
Tell an agent
Test whether {url} matches the page rules {matchPageRules}.
Check if URL {url} would be targeted by my heatmap rules.
GET /index.php?module=API&method=HeatmapSessionRecording.getAvailableStatuses List heatmap and recording statuses · Heatmap session recording get available statuses #
Ask an LLM
“What statuses can a heatmap or session recording be in?”
“Which status values are valid for recordings?”
Tell an agent
List the valid heatmap and session recording statuses.
Show all possible statuses for heatmaps and recordings.
GET /index.php?module=API&method=HeatmapSessionRecording.getAvailableTargetPageRules List page-matching rule types · Heatmap session recording get available target page rules #
Ask an LLM
“Which attributes and rule types can I use to target pages?”
“What page matching options exist for heatmap targeting?”
Tell an agent
List the available target page rule types.
Show which URL attributes and comparisons page rules support.
GET /index.php?module=API&method=HeatmapSessionRecording.getAvailableDeviceTypes List heatmap device types · Heatmap session recording get available device types #
Ask an LLM
“Which device types can heatmap reports be filtered by?”
“Are desktop, tablet and mobile all supported for heatmaps?”
Tell an agent
List the device types supported by heatmap reports.
Show which devices I can break heatmaps down by.
GET /index.php?module=API&method=HeatmapSessionRecording.getAvailableHeatmapTypes List heatmap activity types · Heatmap session recording get available heatmap types #
Ask an LLM
“What kinds of heatmaps can I view, like clicks or scrolls?”
“Which heatmap activity types are supported?”
Tell an agent
List the available heatmap types.
Show the click, move and scroll heatmap type values.
GET /index.php?module=API&method=HeatmapSessionRecording.getAvailableSessionRecordingSampleLimits List allowed session recording sample limits · Heatmap session recording get available session recording sample limits #
Ask an LLM
“What sample limit values can I choose for a session recording?”
“What is the maximum number of sessions a recording can sample?”
Tell an agent
List the allowed session recording sample limits.
Show the sample limit options for session recordings.
GET /index.php?module=API&method=HeatmapSessionRecording.getEventTypes List event types in recorded sessions · Heatmap session recording get event types #
Ask an LLM
“What event types can show up in recorded session data?”
“How do I interpret the event type codes in a session replay?”
Tell an agent
List the event types used in recorded session data.
Show what each recorded session event type means.

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: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