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 including the deletion of heatmap screenshots. It allows users to interact with Matomo's extensive analytics and management API by specifying the resource and operation, along with query parameters and request body data. This node is useful for automating analytics tasks such as managing heatmaps, session recordings, and other Matomo modules programmatically within workflows.

Use Case Examples

  1. Deleting a heatmap screenshot for a specific site by providing the necessary identifiers and authentication token.
  2. Managing heatmap session recordings by adding, updating, or deleting heatmaps and session recordings through API calls.
  3. Fetching available device types or heatmap types for session recordings to configure analytics setups.

Properties

Name Meaning
Query Parameters Collection of optional query parameters to filter or specify details for the API request, such as IDs, flags, and other settings relevant to the operation.
Request Body JSON object containing the request body data for POST, PUT, PATCH operations, used to send detailed parameters or payloads to the API.

Output

JSON

  • response - The JSON response returned from the Matomo API call, containing data or confirmation of the requested operation.

Dependencies

  • An API key credential for Matomo API authentication

Troubleshooting

  • Ensure the Matomo domain URL and authentication token are correctly configured in the node credentials to avoid authentication errors.
  • Verify that the specified resource and operation names are valid and supported by the Matomo API to prevent unknown resource or method errors.
  • Check the format and content of query parameters and request body JSON to ensure they meet the API requirements and avoid request failures.
  • If the API returns a 204 No Content status, it indicates the operation was successful but no data was returned; handle this case appropriately in your workflow.

Discussion