Matomo icon

Matomo

Use the Matomo API

Actions539

Overview

This node integrates with the Matomo API, allowing users to perform various operations across multiple Matomo resources. Specifically, for the 'API' resource and 'Get Report Metadata' operation, it fetches metadata for report pages of a given site. The node constructs API requests dynamically based on user-selected resource and operation, along with provided query parameters and request body. It supports a wide range of Matomo modules and methods, making it versatile for analytics, reporting, and management tasks within Matomo.

Use Case Examples

  1. Fetching metadata for a specific report to understand available metrics and dimensions.
  2. Retrieving report pages metadata to display or process in an analytics workflow.
  3. Using the generic API report method to get custom analytics data by specifying the API method and parameters.

Properties

Name Meaning
Query Parameters A collection of key-value pairs to customize the API request, such as filtering by site ID, date, segment, and other report-specific options.
Request Body JSON object for POST operations to send additional data or parameters required by certain API methods.

Output

JSON

  • json - The JSON response from the Matomo API containing report metadata or other requested data.

Dependencies

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

Troubleshooting

  • Ensure that the Matomo domain URL and authentication token are correctly configured in the node credentials; missing these will cause errors.
  • Verify that the selected resource and operation are supported and correctly spelled; unknown resources or operations will throw errors.
  • Check that query parameters are valid and appropriate for the selected API method to avoid API errors.
  • For POST requests, ensure the request body is valid JSON; malformed JSON will cause request failures.

Links

Discussion