Overview

This node interacts with the Workboard API to perform various operations on different resources such as users, goals, teams, metrics, activities, workstreams, tags, datastreams, and webhooks. Specifically, for the Metric resource with the Get All operation, it retrieves a list of metrics from the Workboard system, supporting query parameters like limit, offset, sorting, and filtering. This is useful for scenarios where users need to fetch and analyze multiple metrics data for reporting, monitoring, or integration purposes.

Use Case Examples

1. Fetching all metrics with a limit of 100 to display in a dashboard.
2. Retrieving metrics sorted by a specific field in descending order for detailed analysis.
3. Filtering metrics based on certain criteria to focus on relevant data.

Properties

Output

JSON

• * - Array of metric objects returned from the Workboard API, each representing a metric with its details.

Dependencies

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

Troubleshooting

• Common issues include authentication errors due to invalid or expired API tokens. Ensure the API key credential is correctly configured and valid.
• Incorrect query parameters may result in empty or unexpected results. Verify the parameters like limit, offset, sort_by, and filter are correctly set.
• API rate limits or network issues may cause request failures. Check network connectivity and API usage limits.

Links

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