Matomo icon

Matomo

Use the Matomo API

Actions542

Annotation → Get Annotation

AI-generated

Overview

This node integrates with the Matomo API to perform various operations related to the 'Annotation' resource, specifically the 'Get Annotation' operation. It allows users to retrieve a single annotation by its note ID, supporting a wide range of query parameters to customize the request. This node is useful for fetching detailed annotation data from Matomo for analytics and reporting purposes.

Use Case Examples

  1. Retrieve a specific annotation by its note ID to analyze user comments or notes associated with a website visit.
  2. Fetch annotation details including text content to display in a custom dashboard or report.

Properties

Name Meaning
Query Parameters A collection of optional parameters to customize the API request for fetching annotations, such as filtering by site ID, date, or including annotation text.

Output

JSON

  • json - The JSON response from the Matomo API containing the annotation 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 an error.
  • Verify that the note ID provided in the query parameters is valid and exists in the Matomo instance to avoid empty or error responses.
  • Check network connectivity and Matomo API availability if requests fail or time out.

Links

Discussion