Workboard - SJI icon

Workboard - SJI

Interact with Workboard API

Metric → Get

AI-generated

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 operation, it retrieves detailed information about a specific metric by its ID. This is useful for scenarios where you need to fetch metric data for reporting, monitoring, or integration purposes within workflows.

Use Case Examples

  1. Retrieve a specific metric's details by providing its Metric ID to monitor performance indicators.
  2. Fetch metric information to integrate with other business intelligence tools or dashboards.

Properties

Name Meaning
Metric ID The ID of the metric to retrieve information for.

Output

JSON

  • id - The unique identifier of the metric.
  • name - The name of the metric.
  • description - A detailed description of the metric.
  • value - The current value or status of the metric.
  • tags - Tags associated with the metric for categorization.
  • created_at - Timestamp when the metric was created.
  • updated_at - Timestamp when the metric was last updated.

Dependencies

  • Requires an API key credential for authentication with the Workboard API.

Troubleshooting

  • Ensure the Metric ID provided is correct and exists in the Workboard system to avoid 'not found' errors.
  • Verify that the API key credential is valid and has the necessary permissions to access metric data.
  • Check network connectivity and the base URL configuration if requests fail to reach the Workboard API.
  • Handle API rate limits by implementing retry logic or adjusting request frequency.

Links

Discussion