Matomo icon

Matomo

Use the Matomo API

Actions539

Overview

This node integrates with the Matomo API to perform various operations across multiple resources, including heatmap session recording. Specifically, the 'End Session Recording' operation under the 'Heatmap Session Recording' resource allows users to end and finalize a session recording for a specified site. This is useful for managing user session recordings in web analytics, enabling users to programmatically control the lifecycle of session recordings.

Use Case Examples

  1. Ending a session recording after a user completes a session on a website to finalize data collection and analysis.
  2. Automating the process of stopping session recordings at specific times or events within a workflow.

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 body for POST, PUT, PATCH operations, allowing detailed data to be sent to the API.

Output

JSON

  • json - The JSON response from the Matomo API call, which varies depending on the resource and operation executed.

Dependencies

  • An API key credential for authenticating with the Matomo API.

Troubleshooting

  • Ensure the domain URL and authentication token are correctly configured in the node credentials to avoid authentication errors.
  • Verify that the selected resource and operation are supported and correctly spelled to prevent unknown resource or operation errors.
  • Check the format and content of query parameters and request body JSON to avoid malformed request 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 behavior in some cases.

Discussion