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 the 'Get Available Session Recording Sample Limits' operation among many others. It allows users to query Matomo for analytics data, manage heatmaps, session recordings, and other related functionalities by specifying the resource and operation along with query parameters and request body data. This node is useful for automating data retrieval and management tasks in Matomo analytics, such as fetching session recording limits, managing heatmaps, and analyzing user interactions.

Use Case Examples

  1. A user wants to retrieve the available session recording sample limits for a website to understand how many sessions can be recorded before data collection stops.
  2. A user needs to add a new heatmap or session recording with specific rules and configurations to track user interactions on their site.
  3. A user wants to pause or resume a session recording or heatmap to control data collection periods.

Properties

Name Meaning
Query Parameters Collection of optional parameters to filter or specify details for the API request, such as site ID, date, device type, and many others relevant to the Matomo API.

Output

JSON

  • response - The JSON response from the Matomo API call, which varies depending on the selected resource and operation. It may include data such as available session recording sample limits, heatmap details, or other analytics data.

Dependencies

  • Requires 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 selected resource and operation are supported and correctly spelled; unknown resources or operations will throw an error.
  • Check the query parameters for correctness and completeness as invalid or missing parameters may result in API errors or empty responses.
  • If the API response is empty or unexpected, verify the Matomo server status and API endpoint accessibility.

Links

  • Matomo API Reference - Official documentation for the Matomo API, detailing available modules, methods, and parameters.

Discussion