Matomo icon

Matomo

Use the Matomo API

Actions539

Overview

This node integrates with the Matomo API to perform various operations on different Matomo resources. Specifically, for the 'Custom Report' resource and the 'Duplicate Custom Report' operation, it duplicates an existing custom report to specified sites. The node constructs the appropriate API request URL based on the selected resource and operation, appends query parameters, and sends HTTP requests to the Matomo API. It supports a wide range of Matomo modules and operations, making it versatile for analytics and management tasks within Matomo.

Use Case Examples

  1. Duplicating a custom report to multiple sites by specifying the report ID and destination site IDs.
  2. Fetching available categories or metrics for custom reports to configure reports dynamically.
  3. Managing custom reports by adding, updating, pausing, or resuming reports through the API.

Properties

Name Meaning
Query Parameters A collection of optional parameters to customize the API request, such as IDs, filters, flags, and other settings relevant to the selected operation.
Request Body A JSON object representing the request payload for POST, PUT, PATCH operations, allowing detailed configuration or data submission to the API.

Output

JSON

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

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 and correctly spelled to avoid unknown resource errors.
  • Check the format and content of query parameters and request body JSON to prevent malformed requests.
  • If the API returns an error, inspect the error message and stack trace provided by the node for debugging.

Links

Discussion