Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

WorkBoard Metric (Key Result) API

The Metric (Key Result) API from WorkBoard — 6 operation(s) for metric (key result).

WorkBoard Metric (Key Result) API is one of 12 APIs that WorkBoard publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Metric (Key Result). The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and a changelog.

This API exposes 10 operations across 6 paths. It is described by OpenAPI 3.0.1, at version 1.0.0.

Requests are made against a single base URL, https://demo.biz.wobo-int.com/wb/apis.

10 operations 6 paths 0 schemas 1 DELETE5 GET1 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0.0
Base URL
https://www.myworkboard.com/wb/apis
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

WorkBoard Metric (Key Result) API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth).

  • bearerAuth — JWT Authorization header using the Bearer scheme.

Paths & Operations 10

Across 6 paths, the API surfaces 10 operations — 1 DELETE, 5 GET, 1 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Metric (Key Result) 10
GET
/metric
Request metrics (key results) the user (token owner) has access to. Use a Data-Admin token to gain access to metrics across your organization.
6 params → 200400
GET
/metric/{metric_id_path}
GET a single individual metric (key results) the user has access to. Use a Data-Admin token to get an organization's single metric.
2 params → 200400
PUT
/metric/{metric_id_path}
Update metric information
2 params body → 200400
PUT
/metric/{metric_id_path}/confidence
Update the confidence score (RAG) of a metric (key result)
1 param body → 200400500
GET
/metric/{metric_id_path}/tags
Returns all tags mapped to the given metric in the system.
1 param → 200400
PUT
/metric/{metric_id_path}/tags
Add multiple tags to the given metric. Maximum tag list allowed is 50 per request. Only valid tags will be considered.
1 param body → 200400
DELETE
/metric/{metric_id_path}/tags
Delete given tag lists mapped to the metric.
1 param body → 200400
GET
/metric/krtags
Returns all key result tags mapped to the given metrics in the system.
1 param → 200400
GET
/metric/tags
Returns all metrics mapped to the given tagid.
3 params → 200400
POST
/metric/tags
Add multiple tags to multiple metrics. Maximum tag list allowed is 50 per request. Only valid tags will be considered.
body → 200400

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

workboard-metric-key-result-api-openapi.yml Raw ↑

Other APIs WorkBoard publishes across the network.

WorkBoard SCIM API
WorkBoard Activity (Action Items) API
WorkBoard custom-attributes API
WorkBoard Datastream API
WorkBoard Goal (Objective) API
WorkBoard Tags API
WorkBoard Team API
WorkBoard User API
WorkBoard User Goals (User Objectives) API
WorkBoard Webhook API
WorkBoard Workstream API