Matomo icon

Matomo

Use the Matomo API

Actions539

Overview

This node interacts with the Matomo API to perform various operations related to the Heatmap Session Recording resource, specifically the 'End Heatmap' operation. It allows users to end and finalize a heatmap for a site by sending the appropriate API request with customizable query parameters and request body. This node is useful for managing heatmap data collection and analysis in web analytics workflows.

Use Case Examples

  1. Ending a heatmap session recording for a specific site to finalize data collection.
  2. Sending custom query parameters to filter or specify details when ending a heatmap.
  3. Using the request body to provide additional data or configuration when ending a heatmap.

Properties

Name Meaning
Query Parameters Collection of optional query parameters to customize the API request when ending a heatmap, such as site ID, heatmap type, device type, and other filters.

Output

JSON

  • json - The JSON response from the Matomo API call, containing the result of ending the heatmap session recording.

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 to avoid authentication errors.
  • Verify that the query parameters and request body are correctly formatted JSON and match the expected API specifications to prevent request failures.
  • Check the API method and resource names for typos or unsupported values to avoid unknown resource or operation errors.
  • If the API returns a 204 No Content status, it means the request was successful but there is no data to return, which is expected for some operations like ending a heatmap.

Discussion