Workboard - SJI icon

Workboard - SJI

Interact with Workboard API

Actions45

Metric → Get KR Tags

AI-generated

Overview

This node interacts with the Workboard API to perform various operations related to metrics, including retrieving all key result (KR) tags. It is useful for users who want to automate the management and retrieval of metric-related data from Workboard, such as fetching KR tags for reporting or integration purposes.

Use Case Examples

  1. Retrieve all key result tags with optional query parameters like limit, offset, sorting, and filtering to customize the results.
  2. Use the node to get KR tags to analyze or display key results in dashboards or reports.

Properties

Name Meaning
Query Parameters Parameters to customize the retrieval of KR tags, including limit, offset, sort by, sort order, and filter criteria.

Output

JSON

  • ``
    • tag_id - The unique identifier of each key result tag.
    • tag_name - The name of each key result tag.
    • description - Description or additional details about the key result tag.

Dependencies

  • Requires an API key credential for Workboard API authentication (bearer token).
  • Needs the base URL for the Workboard API, defaulting to https://www.myworkboard.com/wb/apis if not provided.

Troubleshooting

  • Common issues include authentication errors if the API key is missing or invalid. Ensure the Workboard API credentials are correctly configured.
  • Errors may occur if query parameters are invalid or improperly formatted; verify parameter values before execution.
  • Network or API endpoint issues can cause request failures; check connectivity and API status.

Links

Discussion