Matomo icon

Matomo

Use the Matomo API

Actions539

Overview

This node integrates with the Matomo API to perform various operations related to the Heatmap Session Recording resource, specifically the 'Get Embed Session Info' operation among many others. It allows users to query Matomo's analytics data by specifying the resource and operation, along with query parameters and request body data. The node constructs the appropriate API request URL and method based on the selected resource and operation, sends the request to the Matomo API, and returns the response data in JSON format. This is useful for automating data retrieval and management tasks in Matomo, such as fetching session recording embed information, managing heatmaps, and other analytics operations.

Use Case Examples

  1. Fetching embed session information for a specific session recording to embed in a web application.
  2. Retrieving heatmap data for a website to analyze user interactions visually.
  3. Managing session recordings and heatmaps programmatically for automated reporting or integration with other tools.

Properties

Name Meaning
Query Parameters A collection of key-value pairs used to filter or specify details for the API request. These parameters vary widely depending on the operation and resource, such as IDs, dates, filters, and flags.

Output

JSON

  • json - The JSON response from the Matomo API containing the requested data or operation result.

Dependencies

  • Matomo API endpoint and an authentication token (API key) are required.

Troubleshooting

  • Ensure that the Matomo domain URL and authentication token are correctly provided in the node credentials; missing these will cause errors.
  • Verify that the selected resource and operation are supported and correctly spelled; unknown resources or operations will throw errors.
  • Check that query parameters are correctly formatted and valid for the chosen operation to avoid API errors.
  • If the API response is empty or unexpected, verify the permissions and access rights of the API token used.

Links

  • Matomo API Reference - Official documentation for the Matomo API, detailing available resources, methods, and parameters.

Discussion