Overview

This node interacts with the Workboard API to manage metrics, specifically allowing users to add tags to a metric. It is useful in scenarios where you want to categorize or label metrics for better organization and filtering within the Workboard platform. For example, you can add tags to a metric to indicate its priority, status, or related team, enhancing metric tracking and reporting.

Use Case Examples

1. Adding tags to a specific metric to categorize it by priority or department.
2. Bulk tagging multiple metrics for easier filtering and reporting.

Properties

Output

JSON

• success - Indicates if the tag addition operation was successful.
• tags - The tags that were added to the metric (if returned by the API).
• metricId - The ID of the metric to which tags were added.

Dependencies

• Requires an API key credential for Workboard API authentication (bearer token).

Troubleshooting

• Ensure the Metric ID is valid and exists in the Workboard system to avoid errors.
• Verify that the API key credential is correctly configured and has the necessary permissions to modify metrics.
• If the tags JSON is malformed, the API request may fail; ensure the tags are properly formatted as an array of objects with tag_id and tag_name.
• Common error messages may include authentication errors (invalid token), resource not found (invalid metric ID), or validation errors for the tags data. Check the error message details and correct the input accordingly.

Links

• Workboard API Documentation - Official API documentation for Workboard, useful for understanding available endpoints and data formats.