Matomo icon

Matomo

Use the Matomo API

Actions539

Overview

This node integrates with the Matomo API to perform various operations related to custom reports and other Matomo resources. Specifically, for the 'Custom Report' resource and 'Resume Custom Report' operation, it resumes a paused custom report in Matomo. The node is useful for automating the management of Matomo analytics reports, such as resuming reports, adding new reports, updating, or deleting them. It supports a wide range of Matomo API methods across different resources, allowing users to interact programmatically with Matomo analytics data and configurations.

Use Case Examples

  1. Resuming a paused custom report to continue data collection and analysis.
  2. Automating the management of custom reports in Matomo as part of a data workflow.
  3. Fetching and manipulating various Matomo analytics resources like actions, goals, and user data.

Properties

Name Meaning
Query Parameters Collection of key-value pairs to specify parameters for the Matomo API request, such as report IDs, site IDs, date ranges, and other filters relevant to the operation.
Request Body JSON object containing the request payload for POST, PUT, PATCH operations to send data to the Matomo API.

Output

JSON

  • json - The JSON response from the Matomo API call, containing data or status information 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 'resource' and 'operation' parameters are correctly set to valid values supported by the node.
  • Check the format and content of 'queryParameters' and 'requestBody' to match the expected API requirements for the selected operation.
  • Network or API endpoint issues may cause request failures; verify connectivity and Matomo server status.
  • Error messages from the Matomo API are wrapped and presented; review the error message and stack trace for debugging.

Links

Discussion