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 'Add Heatmap' operation. It allows users to add a new heatmap for tracking with specified rules by sending a properly constructed API request to the Matomo server. This node is useful for users who want to programmatically manage heatmap data collection and analysis within their Matomo analytics setup, enabling automation of heatmap creation based on dynamic input parameters.

Use Case Examples

  1. Automatically create heatmaps for new pages added to a website to analyze user interaction.
  2. Add heatmaps with specific device type or heatmap type filters to segment user behavior.
  3. Integrate heatmap creation into a larger workflow that includes session recording and user behavior analysis.

Properties

Name Meaning
Query Parameters A collection of optional query parameters to customize the API request for adding a heatmap, such as device type, heatmap type, and other filters.

Output

JSON

  • json - The JSON response from the Matomo API call, typically containing details about the added heatmap or the result of the API operation.

Dependencies

  • An API key credential for Matomo API authentication

Troubleshooting

  • Ensure that the Matomo domain URL and authentication token are correctly configured in the node credentials; missing or incorrect credentials will cause authentication errors.
  • Verify that the query parameters are correctly formatted and valid for the 'Add Heatmap' operation to avoid API request errors.
  • Check the API endpoint URL construction for correctness, especially the method parameter corresponding to the 'Add Heatmap' operation.
  • If the API response is empty or unexpected, confirm that the Matomo server is reachable and the API method is supported in the Matomo version used.

Discussion