How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Matomo HeatmapSessionRecording API

The Matomo HeatmapSessionRecording API exposes 31 operations of the Matomo Reporting API (module `HeatmapSessionRecording`). Heatmaps and session recordings — configure them, read recorded heatmap data, and list, fetch and delete recorded sessions. Every operation is dispatched through the single `/index.php?module=API&method=HeatmapSessionRecording.` entrypoint on the customer's own Matomo instance, self-hosted or on Matomo Cloud. The OpenAPI 3.1.0 document is Matomo's own, generated by its first-party ApiReference plugin.

Matomo HeatmapSessionRecording API is one of 61 APIs that Matomo publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Analytics, Heatmaps, Session Recording, and User Behavior. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 31 operations across 31 paths, and defines 4 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against a single base URL, https://demo-proxy.innocraft.cloud/.

31 operations 31 paths 4 schemas 31 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://{matomo_host}/index.php
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Matomo HeatmapSessionRecording API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (MatomoToken). By default, every request must be authenticated.

  • MatomoToken — Paste your token generated from Personal Security. Swagger will send it as a Bearer token.

Paths & Operations 31

Across 31 paths, the API surfaces 31 operations — 31 GET. Each is listed below with its method, path, parameters, and response codes.

HeatmapSessionRecording 31

Exposes the Heatmap & Session Recording API endpoints for managing configurations and retrieving recorded activity. Heatmap coordinates use relative values: X and Y positions rang…

GET
/index.php?module=API&method=HeatmapSessionRecording.addHeatmap
Adds a new heatmap.
HeatmapSessionRecording.addHeatmap 13 params → 200400401403404500default
GET
/index.php?module=API&method=HeatmapSessionRecording.duplicateHeatmap
Copies a specified heatmap to one or more sites. If a heatmap with the same name already exists, the new heatmap will have an automatically adjusted name to make it unique to the assigned site.
HeatmapSessionRecording.duplicateHeatmap 4 params → 200400401403404500default
GET
/index.php?module=API&method=HeatmapSessionRecording.updateHeatmap
Updates an existing heatmap.
HeatmapSessionRecording.updateHeatmap 14 params → 200400401403404500default
GET
/index.php?module=API&method=HeatmapSessionRecording.deleteHeatmapScreenshot
Deletes the stored snapshot (screenshot) for a heatmap.
HeatmapSessionRecording.deleteHeatmapScreenshot 4 params → 200400401403404500default
GET
/index.php?module=API&method=HeatmapSessionRecording.addSessionRecording
Adds a new session recording.
HeatmapSessionRecording.addSessionRecording 11 params → 200400401403404500default
GET
/index.php?module=API&method=HeatmapSessionRecording.updateSessionRecording
Updates an existing session recording.
HeatmapSessionRecording.updateSessionRecording 12 params → 200400401403404500default
GET
/index.php?module=API&method=HeatmapSessionRecording.getHeatmap
Returns a single heatmap configuration.
HeatmapSessionRecording.getHeatmap 3 params → 200400401403404500default
GET
/index.php?module=API&method=HeatmapSessionRecording.getSessionRecording
Returns a single session recording configuration.
HeatmapSessionRecording.getSessionRecording 3 params → 200400401403404500default
GET
/index.php?module=API&method=HeatmapSessionRecording.pauseHeatmap
Pauses a heatmap configuration.
HeatmapSessionRecording.pauseHeatmap 3 params → 200400401403404500default
GET
/index.php?module=API&method=HeatmapSessionRecording.resumeHeatmap
Resumes a paused heatmap configuration.
HeatmapSessionRecording.resumeHeatmap 3 params → 200400401403404500default
GET
/index.php?module=API&method=HeatmapSessionRecording.deleteHeatmap
Deletes a heatmap configuration.
HeatmapSessionRecording.deleteHeatmap 3 params → 200400401403404500default
GET
/index.php?module=API&method=HeatmapSessionRecording.endHeatmap
Ends a heatmap configuration.
HeatmapSessionRecording.endHeatmap 3 params → 200400401403404500default
GET
/index.php?module=API&method=HeatmapSessionRecording.pauseSessionRecording
Pauses a session recording configuration.
HeatmapSessionRecording.pauseSessionRecording 3 params → 200400401403404500default
GET
/index.php?module=API&method=HeatmapSessionRecording.resumeSessionRecording
Resumes a paused session recording configuration.
HeatmapSessionRecording.resumeSessionRecording 3 params → 200400401403404500default
GET
/index.php?module=API&method=HeatmapSessionRecording.deleteSessionRecording
Deletes a session recording configuration.
HeatmapSessionRecording.deleteSessionRecording 3 params → 200400401403404500default
GET
/index.php?module=API&method=HeatmapSessionRecording.endSessionRecording
Ends a session recording configuration.
HeatmapSessionRecording.endSessionRecording 3 params → 200400401403404500default
GET
/index.php?module=API&method=HeatmapSessionRecording.getHeatmaps
Returns all non-deleted heatmaps for a website.
HeatmapSessionRecording.getHeatmaps 3 params → 200400401403404500default
GET
/index.php?module=API&method=HeatmapSessionRecording.getSessionRecordings
Returns all non-deleted session recordings for a website.
HeatmapSessionRecording.getSessionRecordings 2 params → 200400401403404500default
GET
/index.php?module=API&method=HeatmapSessionRecording.getRecordedSessions
Returns all recorded sessions for a specific session recording.
HeatmapSessionRecording.getRecordedSessions 7 params → 200400401403404500default
GET
/index.php?module=API&method=HeatmapSessionRecording.getRecordedSession
Get all activities of a specific recorded session.
HeatmapSessionRecording.getRecordedSession 4 params → 200400401403404500default
GET
/index.php?module=API&method=HeatmapSessionRecording.deleteRecordedSession
Deletes all recorded page views within a recorded session.
HeatmapSessionRecording.deleteRecordedSession 4 params → 200400401403404500default
GET
/index.php?module=API&method=HeatmapSessionRecording.deleteRecordedPageview
Deletes an individual page view within a recorded session.
HeatmapSessionRecording.deleteRecordedPageview 4 params → 200400401403404500default
GET
/index.php?module=API&method=HeatmapSessionRecording.getRecordedHeatmapMetadata
Returns summary metadata for a recorded heatmap.
HeatmapSessionRecording.getRecordedHeatmapMetadata 6 params → 200400401403404500default
GET
/index.php?module=API&method=HeatmapSessionRecording.getRecordedHeatmap
Get all activities of a heatmap.
HeatmapSessionRecording.getRecordedHeatmap 8 params → 200400401403404500default
GET
/index.php?module=API&method=HeatmapSessionRecording.testUrlMatchPages
Tests, checks whether the given URL matches the given page rules.
HeatmapSessionRecording.testUrlMatchPages 3 params → 200400401403404500default
GET
/index.php?module=API&method=HeatmapSessionRecording.getAvailableStatuses
Returns the valid heatmap and session recording statuses.
HeatmapSessionRecording.getAvailableStatuses 1 param → 200400401403404500default
GET
/index.php?module=API&method=HeatmapSessionRecording.getAvailableTargetPageRules
Returns the available target attributes and rule types for page matching.
HeatmapSessionRecording.getAvailableTargetPageRules 1 param → 200400401403404500default
GET
/index.php?module=API&method=HeatmapSessionRecording.getAvailableDeviceTypes
Returns the device types supported by the heatmap reporting endpoints.
HeatmapSessionRecording.getAvailableDeviceTypes 1 param → 200400401403404500default
GET
/index.php?module=API&method=HeatmapSessionRecording.getAvailableHeatmapTypes
Returns the heatmap activity types supported by the heatmap reporting endpoints.
HeatmapSessionRecording.getAvailableHeatmapTypes 1 param → 200400401403404500default
GET
/index.php?module=API&method=HeatmapSessionRecording.getAvailableSessionRecordingSampleLimits
Get a list of available session recording sample limits.
HeatmapSessionRecording.getAvailableSessionRecordingSampleLimits 1 param → 200400401403404500default
GET
/index.php?module=API&method=HeatmapSessionRecording.getEventTypes
Returns the event types that may appear in recorded session data.
HeatmapSessionRecording.getEventTypes 1 param → 200400401403404500default

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are Error (3 properties), GenericSuccess (3 properties), ErrorXml (1 property), GenericSuccessXml (1 property). Each schema is shown below with its type and property counts.

GenericSuccess
object
Generic Matomo success payload.
3 properties 2 required
GenericSuccessXml
object
Generic Matomo success payload in XML.
1 property 1 required
Error
object
Generic Matomo error payload.
3 properties 2 required
ErrorXml
object
Generic Matomo error payload in XML.
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

matomo-heatmap-session-recording-openapi.json Raw ↑

Other APIs Matomo publishes across the network.

Matomo Live API
Matomo Goals API
Matomo Segments API
Matomo Reporting API (index.php entrypoint)
Matomo Tracking API (matomo.php entrypoint)
Matomo SitesManager API
Matomo TagManager API
Matomo UsersManager API
Matomo CrashAnalytics API
Matomo FormAnalytics API
Matomo Referrers API
Matomo Funnels API
Where this information came from

This is an independent, third-party profile of Matomo HeatmapSessionRecording API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.