Matomo icon

Matomo

Use the Matomo API

Actions539

Overview

This node integrates with the Matomo API to perform various operations related to the 'Annotation' resource, specifically the 'Get All Annotations' operation. It allows users to retrieve all annotations for a specified site and period, supporting a wide range of query parameters to filter and customize the data retrieval. This node is useful for analytics and reporting scenarios where users need to access annotation data from Matomo for insights or further processing.

Use Case Examples

  1. Retrieve all annotations for a specific website within a given date range to analyze user comments or notes related to site activity.
  2. Fetch annotations with specific filters such as starred annotations or annotations containing text to focus on important or relevant notes.

Properties

Name Meaning
Query Parameters A collection of optional parameters to filter and customize the annotations retrieval, such as site ID, date range, limit, and whether to include annotation text.

Output

JSON

  • json - The JSON response containing the list of annotations retrieved from Matomo API

Dependencies

  • An API key credential for Matomo API authentication

Troubleshooting

  • Ensure that the Matomo domain URL and authentication token are correctly configured in the node credentials to avoid authentication errors.
  • Verify that the query parameters are correctly formatted and valid according to Matomo API documentation to prevent request failures.
  • If the API response is empty or returns a 204 status, check the site ID and date range parameters to ensure they correspond to existing data in Matomo.
  • Network issues or incorrect API endpoint URLs can cause request failures; verify network connectivity and the correctness of the Matomo domain URL.

Links

Discussion