Workboard - SJI icon

Workboard - SJI

Interact with Workboard API

Goal → Get Metric

AI-generated

Overview

This node interacts with the Workboard API to retrieve a specific metric associated with a particular goal. It is useful in scenarios where users need to fetch detailed metric data for a goal to monitor progress or analyze performance. For example, a project manager might use this node to get the current status of a key performance indicator (KPI) metric tied to a strategic goal.

Use Case Examples

  1. Retrieve a metric by providing the Goal ID and Metric ID to monitor progress on a specific goal.
  2. Fetch detailed metric information for reporting or dashboard display.

Properties

Name Meaning
Goal ID The ID of the goal for which the metric is being retrieved.
Metric ID The ID of the specific metric to retrieve for the given goal.

Output

JSON

  • metricId - The ID of the retrieved metric.
  • goalId - The ID of the goal associated with the metric.
  • metricDetails - Detailed information about the metric retrieved from the Workboard API.

Dependencies

  • Workboard API with JWT Bearer Token authentication

Troubleshooting

  • Ensure that the provided Goal ID and Metric ID are correct and exist in the Workboard system to avoid 'not found' errors.
  • Verify that the API credentials (JWT Bearer Token) are valid and have the necessary permissions to access goal metrics.
  • If the node returns an error, check the error message for details and ensure the API endpoint URL is correct and accessible.

Links

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

Discussion