Workboard - SJI icon

Workboard - SJI

Interact with Workboard API

Metric → Get By Tag

AI-generated

Overview

This node interacts with the Workboard API to retrieve metrics filtered by a specific tag. It is useful for scenarios where users want to fetch metrics associated with a particular tag, such as tracking performance indicators or key results linked to specific tags. For example, a user can get all metrics tagged with 'Q2 Goals' to analyze progress on quarterly objectives.

Use Case Examples

  1. Retrieve all metrics tagged with a specific tag ID to monitor related key results.
  2. Fetch metrics filtered by tags to generate reports or dashboards based on tagged categories.

Properties

Name Meaning
Tag ID The ID of the tag to filter metrics by, used to specify which tag's metrics to retrieve.
Query Parameters Optional parameters to control the result set, including limit, offset, sorting, and filtering criteria.

Output

JSON

  • * - Array of metric objects matching the tag filter criteria

Dependencies

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

Troubleshooting

  • Common issues include invalid or missing tag ID, resulting in no metrics returned or API errors.
  • Incorrect query parameters may cause unexpected results or empty responses.
  • API authentication errors if the bearer token is invalid or expired.

Links

Discussion