curl --request POST \
--url https://api.orbit.devotel.io/api/v1/quality/scorecards/composite \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.orbit.devotel.io/api/v1/quality/scorecards/composite"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.orbit.devotel.io/api/v1/quality/scorecards/composite', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.orbit.devotel.io/api/v1/quality/scorecards/composite",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.orbit.devotel.io/api/v1/quality/scorecards/composite"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.orbit.devotel.io/api/v1/quality/scorecards/composite")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/quality/scorecards/composite")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": {
"window": {
"from": "2026-08-12T09:00:00.000Z",
"to": "2026-08-19T09:00:00.000Z",
"period": "week"
},
"scope": {
"queue_id": "queue_support_l1",
"agent_ids": null
},
"kpi_registry": [
{
"numeric_key": "avg_qa_score",
"scope": "qa",
"direction": "increase",
"unit": "percent",
"default_label": "Average QA score"
},
{
"numeric_key": "avg_handle_seconds",
"scope": "voice",
"direction": "decrease",
"unit": "seconds",
"default_label": "Average handle time"
},
{
"numeric_key": "avg_csat",
"scope": "customer",
"direction": "increase",
"unit": "count",
"default_label": "Customer satisfaction (1-5)"
}
],
"results": [
{
"agent_id": "user_2mN4zR7Ld",
"agent_name": "Dana Okafor",
"composite": 84.2,
"covered_count": 3,
"kpis": [
{
"id": "quality",
"numeric_key": "avg_qa_score",
"label": "Quality",
"scope": "qa",
"direction": "increase",
"unit": "percent",
"target": 90,
"guardband": 10,
"weight": 0.4,
"value": 92.14,
"attainment": 100,
"contribution": 40
},
{
"id": "aht",
"numeric_key": "avg_handle_seconds",
"label": "Efficiency",
"scope": "voice",
"direction": "decrease",
"unit": "seconds",
"target": 300,
"guardband": 60,
"weight": 0.35,
"value": 264,
"attainment": 100,
"contribution": 35
},
{
"id": "csat",
"numeric_key": "avg_csat",
"label": "Satisfaction",
"scope": "customer",
"direction": "increase",
"unit": "count",
"target": 4.5,
"guardband": 0.5,
"weight": 0.25,
"value": 4.4,
"attainment": 97.5,
"contribution": 24.38
}
]
}
]
},
"meta": {
"request_id": "req_1a2b3c4d5e",
"timestamp": "2026-08-19T09:00:00.000Z"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "RATE_LIMITED",
"message": "<string>",
"status": 429,
"retry_after": 2
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}Compute a weighted supervisor scorecard
Compute per-agent supervisor scorecards from a REQUEST-supplied KPI definition: 1-10 KPI lines each picking a metric from the closed registry (QA score, handle time, calls answered, queue service level, CSAT, first-contact resolution), a direction, a target + guardband, and a weight. Each KPI line is normalized to a 0-100 attainment (goal met → 100 → progress → 0..100) and the composite is the weight-sum of the covered lines. Weights may be percentages or fractions — they normalise per request. Window is a named period (day|week|month) or an explicit from/to ISO pair; restrict to a team with queue_id or an explicit agent_ids allow-list. Supervisors are limited to their mapped queues. Reviewer scope (owner / admin / supervisor).
curl --request POST \
--url https://api.orbit.devotel.io/api/v1/quality/scorecards/composite \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.orbit.devotel.io/api/v1/quality/scorecards/composite"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.orbit.devotel.io/api/v1/quality/scorecards/composite', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.orbit.devotel.io/api/v1/quality/scorecards/composite",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.orbit.devotel.io/api/v1/quality/scorecards/composite"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.orbit.devotel.io/api/v1/quality/scorecards/composite")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/quality/scorecards/composite")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": {
"window": {
"from": "2026-08-12T09:00:00.000Z",
"to": "2026-08-19T09:00:00.000Z",
"period": "week"
},
"scope": {
"queue_id": "queue_support_l1",
"agent_ids": null
},
"kpi_registry": [
{
"numeric_key": "avg_qa_score",
"scope": "qa",
"direction": "increase",
"unit": "percent",
"default_label": "Average QA score"
},
{
"numeric_key": "avg_handle_seconds",
"scope": "voice",
"direction": "decrease",
"unit": "seconds",
"default_label": "Average handle time"
},
{
"numeric_key": "avg_csat",
"scope": "customer",
"direction": "increase",
"unit": "count",
"default_label": "Customer satisfaction (1-5)"
}
],
"results": [
{
"agent_id": "user_2mN4zR7Ld",
"agent_name": "Dana Okafor",
"composite": 84.2,
"covered_count": 3,
"kpis": [
{
"id": "quality",
"numeric_key": "avg_qa_score",
"label": "Quality",
"scope": "qa",
"direction": "increase",
"unit": "percent",
"target": 90,
"guardband": 10,
"weight": 0.4,
"value": 92.14,
"attainment": 100,
"contribution": 40
},
{
"id": "aht",
"numeric_key": "avg_handle_seconds",
"label": "Efficiency",
"scope": "voice",
"direction": "decrease",
"unit": "seconds",
"target": 300,
"guardband": 60,
"weight": 0.35,
"value": 264,
"attainment": 100,
"contribution": 35
},
{
"id": "csat",
"numeric_key": "avg_csat",
"label": "Satisfaction",
"scope": "customer",
"direction": "increase",
"unit": "count",
"target": 4.5,
"guardband": 0.5,
"weight": 0.25,
"value": 4.4,
"attainment": 97.5,
"contribution": 24.38
}
]
}
]
},
"meta": {
"request_id": "req_1a2b3c4d5e",
"timestamp": "2026-08-19T09:00:00.000Z"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "RATE_LIMITED",
"message": "<string>",
"status": 429,
"retry_after": 2
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}Authorizations
Dashboard JWT token from Clerk
Headers
Stripe-style idempotency token. Pass a stable, client-generated value (1-255 chars) to dedupe retries on transient timeouts. The same key+credential+path replays the original response for 24h on 2xx (5min on 4xx, 30s on 5xx). Returns 409 if a concurrent request with the same key is already in flight; replayed responses include the Idempotency-Replay: true response header.
1 - 255Sandbox opt-in for Clerk-session-authenticated requests — see Test mode explained for the full credential-header matrix and worked samples. Set to true to route the call through the test-mode pipeline: no real provider delivery, no credits deducted, response meta.test_mode: true. Ignored for live API keys (dv_live_sk_*) — server-to-server clients must use a test-prefixed key (dv_test_sk_*) to exercise sandbox. Test-prefixed keys unconditionally enable sandbox regardless of this header.
true, false Response
Per-agent supervisor scorecards for the resolved window and scope, plus the closed KPI registry the scorecard definitions reference. results is empty when no agent in scope has a roster row.