Matomo icon

Matomo

Use the Matomo API

Actions539

Overview

This node interacts with the Matomo API to perform various operations related to the Dashboard resource, specifically including the operation to copy a dashboard to another user. It constructs API requests based on user-selected resource and operation parameters, sends these requests to the Matomo instance, and returns the API response. This node is useful for automating dashboard management tasks in Matomo, such as duplicating dashboards for different users, creating new dashboards, retrieving dashboard lists, removing dashboards, and resetting dashboard layouts.

Use Case Examples

  1. Copy a dashboard to another user by specifying the dashboard ID and the target user's login.
  2. Retrieve a list of all dashboards for a specific user to manage or audit dashboards.
  3. Create a new dashboard for a user with predefined settings or widgets.
  4. Remove a dashboard that is no longer needed for a user to keep the workspace clean.

Properties

Name Meaning
Query Parameters A collection of optional parameters to customize the API request, such as specifying the dashboard ID, user login, or other filters relevant to the dashboard operation.
Request Body A JSON object containing the request payload for POST operations, such as the data needed to copy a dashboard to a user or create a new dashboard.

Output

JSON

  • Status Code - Indicates the HTTP status code or a message when no content is returned
  • json - The JSON response from the Matomo API containing the result of the requested dashboard operation

Dependencies

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

Troubleshooting

  • Ensure that the Matomo domain and authentication token are correctly configured in the node credentials; missing these will cause errors.
  • Verify that the specified user login and dashboard ID exist and that the authenticated user has permission to perform the operation.
  • Check the API method and parameters for correctness, as invalid parameters or unsupported operations will result in API errors.
  • If the API response is empty or unexpected, confirm that the Matomo instance is accessible and the API endpoint is correct.

Links

Discussion