Matomo icon

Matomo

Use the Matomo API

Actions539

Overview

This node integrates with the Matomo API, allowing users to perform a wide range of operations across various Matomo resources such as AB Testing, Actions, Activity Log, Advertising Conversion Export, Annotations, API, and many more. It is designed to facilitate interaction with Matomo's analytics and management features by constructing API requests based on user-selected resources and operations, sending these requests to the Matomo server, and returning the API responses. This node is beneficial for automating data retrieval, management, and reporting tasks within Matomo, such as fetching analytics data, managing experiments, handling user data, and more.

Use Case Examples

  1. Retrieve the current Matomo version using the API resource and 'Get Matomo Version' operation.
  2. Fetch all active A/B testing experiments for a site using the AB Testing resource and 'Get Active Experiments' operation.
  3. Get detailed action metrics for a specific site and period using the Actions resource and 'Get Actions' operation.

Properties

Name Meaning
Query Parameters A collection of optional query parameters to customize the API request, such as filtering, pagination, and specific data attributes.

Output

JSON

  • response - The JSON response data returned from the Matomo API call, which varies depending on the selected resource and operation.

Dependencies

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

Troubleshooting

  • Ensure that the Matomo domain URL and authentication token are correctly provided in the credentials; missing these will cause an error.
  • Verify that the selected resource and operation are valid and supported by the Matomo API to avoid unknown resource errors.
  • Check the format and values of query parameters to ensure they conform to the expected types and constraints of the Matomo API.
  • If the API response is empty or a '204 No Content' status is returned, verify that the request parameters are correct and that data exists for the query.

Links

  • Matomo API Reference - Official documentation for the Matomo API, detailing available resources, methods, and parameters.

Discussion