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 including the deletion of heatmaps. It allows users to specify query parameters to customize the API request and supports multiple operations across different Matomo resources. The node constructs the appropriate API endpoint URL based on the selected resource and operation, sends HTTP requests to the Matomo API, and returns the API response data.

Use Case Examples

  1. Deleting a specific heatmap for a site by providing the heatmap ID and other optional query parameters.
  2. Fetching available heatmap types or device types for session recordings.
  3. Adding or updating heatmaps and session recordings with detailed configuration.

Properties

Name Meaning
Query Parameters Collection of optional query parameters to customize the API request for the heatmap session recording deletion or other operations. Includes parameters like 'id', 'idSite', 'heatmapType', and many others to filter or specify the request.

Output

JSON

  • json - The JSON response from the Matomo API call, which may include details of the deleted heatmap or status information.

Dependencies

  • Matomo API credentials including domain and authentication token

Troubleshooting

  • Ensure that the Matomo API credentials (domain and auth token) are correctly configured; missing credentials will cause an error.
  • Verify that the 'id' parameter for the heatmap to delete is provided and valid, as the API requires it to identify the heatmap.
  • Check the API endpoint URL constructed by the node for correctness, especially the method parameter corresponding to the operation.
  • Handle HTTP errors or API errors gracefully; the node throws a NodeApiError with details if the API call fails.

Links

Discussion