GetPerformanceMetrics

POST

https://api.cbf.tcn.com/api/v1alpha1/wfm/getperformancemetrics

Gets the performance metrics across @datetime_range for shift instances in @schedule_selector associated with @node_selector for the org making the request.
Performance metrics will be generated for each of the given @metric_params.
The @interval_width_in_minutes must be a multiple of 5.
Errors:

grpc.Invalid: the request data is invalid.

grpc.NotFound: the @node_selector, @schedule_selector, or their shift instances doesn't exist.

grpc.Internal: error occurs when getting the data.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

Example

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.cbf.tcn.com/api/v1alpha1/wfm/getperformancemetrics' \
--header 'Content-Type: application/json' \
--data-raw ''

Responses

🟢200OK

application/json

Success

Body

Example

🔴500Server Error

Modified at 2025-08-14 21:02:57

SetDefaultSchedulingTarget

ListRequiredCallsIntervals