Overview

This node integrates with the Matomo API to perform various operations related to the 'Annotation' resource, specifically the 'Add Annotation' operation. It allows users to add new annotations to a given site and date within Matomo, which can be useful for marking important events or notes in analytics data. This node is beneficial for users who want to programmatically manage annotations in Matomo, such as adding contextual information to analytics reports or automating annotation creation based on external triggers.

Use Case Examples

1. Adding an annotation to a Matomo site to mark a marketing campaign launch date.
2. Automatically creating annotations for significant website events like product releases or outages.

Properties

Output

JSON

• json - The JSON response from the Matomo API after adding the annotation, typically including details of the created annotation or status information.

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 authentication errors.
• Verify that the 'Request Body' JSON is correctly formatted and includes all required fields for adding an annotation; malformed JSON will cause request failures.
• Check that the 'Query Parameters' include necessary identifiers such as 'idSite' and 'date' to target the correct site and annotation date.
• If the API returns an error, review the error message for details and ensure the Matomo instance supports the annotation API method being called.

Links

• Matomo Annotation API Documentation - Official documentation for the Matomo Annotation API, detailing available methods and parameters.