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 with the 'Update Custom Report' operation, it updates an existing custom report with new parameters provided by the user. This is useful for managing and modifying custom analytics reports in Matomo, allowing users to tailor reports to their specific needs.

Use Case Examples

  1. Updating a custom report to change its metrics or dimensions based on new business requirements.
  2. Modifying the configuration of an existing custom report to include additional filters or change the report format.

Properties

Name Meaning
Query Parameters A collection of optional parameters to customize the API request, such as filters, IDs, flags, and other settings relevant to the custom report update operation.
Request Body A JSON object containing the data to update the custom report with, such as new metrics, dimensions, or report settings.

Output

JSON

  • json - The JSON response from the Matomo API representing the result of the update operation on the custom report.

Dependencies

  • Matomo API credentials (domain and auth token) are required to authenticate requests.

Troubleshooting

  • Ensure that the Matomo API credentials (domain and auth token) are correctly configured; missing credentials will cause the node to throw an error.
  • Verify that the 'idCustomReport' or other required identifiers are correctly provided in the query parameters or request body to avoid API errors.
  • Check the format of the request body JSON to ensure it matches the expected structure for updating a custom report in Matomo.
  • If the API returns an error, review the error message and stack trace provided by the node for debugging.

Links

Discussion