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 ability to pause session recordings. It constructs API requests based on user-selected operations and query parameters, sends these requests to the Matomo server, and returns the API responses. This node is useful for managing heatmap and session recording data in Matomo, such as pausing recordings, adding heatmaps, or retrieving session data.

Use Case Examples

  1. Pause a session recording for a specific site by providing the session recording ID and relevant query parameters.
  2. Add a new heatmap for tracking user interactions on a website by specifying heatmap details in the request body.
  3. Retrieve a list of available heatmap types or device types supported by Matomo for session recordings.

Properties

Name Meaning
Query Parameters Collection of optional query parameters to customize the API request, such as filtering by site ID, device type, or other Matomo-specific options.
Request Body JSON object containing the request payload for POST, PUT, or PATCH operations, used to send data to the Matomo API.

Output

JSON

  • response - The JSON response returned from the Matomo API call, which varies depending on the operation performed.

Dependencies

  • Matomo API credentials including domain URL and authentication token

Troubleshooting

  • Ensure that the Matomo API credentials (domain and auth token) are correctly configured; missing credentials will cause errors.
  • Verify that the selected resource and operation are supported by the Matomo API and correctly specified in the node parameters.
  • Check the format and content of query parameters and request body JSON to match the expected API requirements.
  • If the API returns an error, review the error message and stack trace provided by the node for debugging.

Links

Discussion