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 'Pause Custom Report' operation, it allows users to pause an active custom report for a site by making an authenticated API request to Matomo. This is useful for managing report generation and controlling data flow in analytics workflows.

Use Case Examples

  1. Pausing an active custom report to temporarily stop data collection or report generation for a specific site.
  2. Managing custom reports programmatically as part of an automated analytics pipeline.

Properties

Name Meaning
Query Parameters Key-value pairs of query parameters to customize the API request for pausing the custom report.
Request Body JSON object containing the request payload for the pause custom report operation.

Output

JSON

  • Status Code - Indicates the HTTP status code or response status from the Matomo API call.
  • json - Parsed JSON response from the Matomo API, typically containing operation results or error details.
  • text - Raw text response from the API if JSON parsing fails.

Dependencies

  • Requires Matomo API credentials including domain URL and authentication token.

Troubleshooting

  • Ensure that the Matomo domain and authentication token credentials are correctly configured; missing credentials will cause errors.
  • Verify that the 'idCustomReport' or other required identifiers are correctly provided in the query parameters or request body to successfully pause the report.
  • Check the API method and parameters for correctness as per Matomo API documentation to avoid request failures.
  • Handle HTTP errors and API error messages gracefully; the node throws detailed errors if the API call fails.

Links

Discussion