Matomo icon

Matomo

Use the Matomo API

Actions539

Overview

This node interacts with the Matomo API to perform various operations related to the 'Custom Dimension' resource, specifically the 'Get Configured Custom Dimensions' operation. It allows users to retrieve all configured custom dimensions for a specified site by sending a properly constructed API request to the Matomo server. This node is useful for analytics and reporting scenarios where understanding or managing custom dimensions in Matomo is required, such as fetching existing custom dimension configurations for analysis or integration with other systems.

Use Case Examples

  1. Retrieve all configured custom dimensions for a website to analyze how custom data is tracked.
  2. Fetch custom dimension settings to synchronize with another analytics platform or for auditing purposes.

Properties

Name Meaning
Query Parameters Collection of optional parameters to filter or specify the API request for custom dimensions, such as site ID, scope, active status, etc.

Output

JSON

  • json - The JSON response from the Matomo API containing the configured custom dimensions data

Dependencies

  • An API key credential for Matomo API authentication

Troubleshooting

  • Ensure that the Matomo domain URL and authentication token are correctly provided in the node credentials to avoid authentication errors.
  • Verify that the query parameters are correctly formatted and valid for the 'Get Configured Custom Dimensions' operation to prevent API request failures.
  • Check network connectivity and Matomo server availability if the API request fails or times out.
  • If the API returns an error message, review the message for details on missing or invalid parameters and adjust the node configuration accordingly.

Discussion