Languages: every operation supports cURL, Node.js (TypeScript), Python, Go, Ruby, and PHP. The first 15 operations on this page show all six languages; the remaining 20 show cURL and TypeScript — the two most-used.

Quality API

Quality endpoints exposed by the Devotel CPaaS API Base path: /api/v1/quality Endpoint count: 35

QA score trend series

GET /api/v1/quality/trends

Time series of official reviewer-authored QA evaluation scores — per-day averages plus per-agent and per-scorecard-form breakdowns. Answers “is quality trending up?” against the scorecard rubrics an org actually grades with; pairs with the point-in-time rollup at GET /quality/summary. Self-evaluations (an agent scoring their own call) and appealed/resolved rows are excluded so only current official scores drive the trend. Read-only; requires an owner, admin, or supervisor role.

string

Look-back window in days over each evaluation’s creation time (1-90). Defaults to 30, capped at 90; an out-of-range or non-numeric value falls back to 30.

string

Restrict the trend to a single scorecard form (rubric) id from /quality/evaluation-forms. Defaults to every form; an over-long value falls back to all forms.

string

Drill the whole trend into one evaluated agent’s scores. Defaults to every agent; an over-long value falls back to all agents.

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/quality/trends?days=30" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/quality/trends?days=30', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/quality/trends?days=30", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/quality/trends?days=30", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/quality/trends?days=30')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/quality/trends?days=30');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

List auto-qa-readiness

GET /api/v1/quality/auto-qa-readiness

string (enum: true|false)

Sandbox opt-in for Clerk-session-authenticated requests. 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.

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/quality/auto-qa-readiness" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/quality/auto-qa-readiness', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/quality/auto-qa-readiness", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/quality/auto-qa-readiness", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/quality/auto-qa-readiness')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/quality/auto-qa-readiness');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": {
    "ready": true,
    "sample_window_days": 7,
    "call_count_last_7d": 1240,
    "min_calls_required": 100,
    "blocking_issues": []
  },
  "meta": {
    "request_id": "req_01HZQX4E7JQ4M2E2H2DM9XE5FJ",
    "timestamp": "2026-08-26T12:00:00.000Z"
  }
}

AI auto-QA coverage rollup

GET /api/v1/quality/autoscore-coverage

Aggregates the automated quality-scoring pipeline (voice AI auto-scoring against the tenant’s active evaluation form) into one supervisor-facing rollup over the trailing 24 hours. Returns completed_calls_last_24h (the at-most-24h denominator the qa-autoscore scheduler drains), auto_scored_calls (count of call_logs that already carry an auto_scored=TRUE qa_evaluations row — including reviewer-overridden rows, which keep provenance=TRUE), coverage_pct (share of completed calls that received an automated score, 0..100 rounded to one decimal), avg_auto_score (mean total_score across the coverable rows), and pending_review_rows (auto_scored count where flagged_for_review is still TRUE and no reviewer has corrected it yet). Replaces the need to manually join qa_evaluations against call_logs; powers the ‘AI automation coverage’ widget on the Quality dashboard. Read-only; owner / admin / supervisor.

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/quality/autoscore-coverage" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/quality/autoscore-coverage', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/quality/autoscore-coverage", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/quality/autoscore-coverage", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/quality/autoscore-coverage')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/quality/autoscore-coverage');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": {
    "window": {
      "hours": 0
    },
    "completed_calls_last_24h": 0,
    "auto_scored_calls": 0,
    "coverage_pct": null,
    "avg_auto_score": null,
    "pending_review_rows": 0
  },
  "meta": {
    "request_id": "req_sample",
    "timestamp": "1970-01-01T00:00:00.000Z"
  }
}

List calibration sessions

GET /api/v1/quality/calibrations

List calibration sessions with optional status / call filters. Each row carries session-level submission counts only — never any individual reviewer’s score. Reviewer scope (owner / admin / supervisor).

string (enum: open|closed)

Filter by session status.

string

Filter by the pinned call.

integer

Maximum sessions to return (1–100, default 50).

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/quality/calibrations" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/quality/calibrations', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/quality/calibrations", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/quality/calibrations", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/quality/calibrations')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/quality/calibrations');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": {
    "items": [
      {}
    ]
  },
  "meta": {
    "request_id": "req_sample",
    "timestamp": "1970-01-01T00:00:00.000Z"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "status": 0,
    "details": {}
  },
  "meta": {
    "request_id": "req_sample",
    "timestamp": "1970-01-01T00:00:00.000Z",
    "docs_url": "https://example.com"
  }
}

Get a calibration session

GET /api/v1/quality/calibrations/{id}

Session detail for the blind-scoring view — roster, submission counts, and the caller’s OWN submitted score only. Never returns another reviewer’s or the AI’s scores; those are revealed by the report once the caller submits. Reviewer scope (owner / admin / supervisor).

string

required

Calibration session identifier.

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/quality/calibrations/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/quality/calibrations/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/quality/calibrations/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/quality/calibrations/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/quality/calibrations/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/quality/calibrations/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": {
    "calibration_id": "qcl_5a7b9c1d3e5f7a9b1c3d5e7f9a",
    "roster": [
      {
        "reviewer_id": "user_2x9v8wJ7kD3qR5mN1pA0",
        "submitted": true
      },
      {
        "reviewer_id": "user_9y3cM2bT4qK7sR1vX8uP",
        "submitted": false
      }
    ],
    "submissions": {
      "pending": 1,
      "submitted": 1
    },
    "caller_submission": {
      "score": 82,
      "submitted_at": "2026-08-26T09:11:34.000Z"
    },
    "reveal_ready": false
  },
  "meta": {
    "request_id": "req_01HZQX4E7JQ4M2E2H2DM9XE5FJ",
    "timestamp": "2026-08-26T12:00:00.000Z"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "status": 0,
    "details": {}
  },
  "meta": {
    "request_id": "req_sample",
    "timestamp": "1970-01-01T00:00:00.000Z",
    "docs_url": "https://example.com"
  }
}

Get the calibration agreement report

GET /api/v1/quality/calibrations/{id}/report

The agreement report — per-criterion variance, overall agreement, each reviewer’s delta from the group consensus, and the AI auto-score’s drift. BLIND-GATED: an invited reviewer who has not yet submitted their own score receives 403. The numeric report is meaningful only once at least two human reviewers have submitted. Reviewer scope (owner / admin / supervisor).

string

required

Calibration session identifier.

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/quality/calibrations/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/report" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/quality/calibrations/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/report', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/quality/calibrations/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/report", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/quality/calibrations/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/report", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/quality/calibrations/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/report')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/quality/calibrations/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/report');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": {
    "session": {},
    "report": {}
  },
  "meta": {
    "request_id": "req_sample",
    "timestamp": "1970-01-01T00:00:00.000Z"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "status": 0,
    "details": {}
  },
  "meta": {
    "request_id": "req_sample",
    "timestamp": "1970-01-01T00:00:00.000Z",
    "docs_url": "https://example.com"
  }
}

Per-agent coaching cards

GET /api/v1/quality/coaching-cards

Aggregate each evaluated agent’s official reviewer-authored QA scorecard feedback — their average score, the share of evaluations flagged for human review, the weakest scorecard criteria to drill, open auto-assigned coaching plans, and short badge chips (‘Low QA score’, ‘flagged for review’, ‘open coaching plans’). Reviewer scope (owner / admin / supervisor) may inspect any agent; a non-reviewer agent is always narrowed to their own card. Sister surface to the regression-style quality trend at GET /quality/trends and the compliance queue at GET /quality/compliance-flags. Read-only.

string

Look-back window in days over each evaluation’s creation time (1–90). Defaults to 30, capped at 90; an out-of-range or non-numeric value falls back to 30.

string

Restrict the rollup to one agent. Defaults to every evaluated agent (or only the caller themselves for a non-reviewer user). An over-long value falls back to the all-agents view.

string

Max agent cards returned (1–50). Defaults to 50, clamped to 50; an out-of-range or non-numeric value falls back to 50.

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/quality/coaching-cards" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/quality/coaching-cards', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/quality/coaching-cards", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/quality/coaching-cards", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/quality/coaching-cards')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/quality/coaching-cards');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": {
    "window": {
      "days": 0,
      "agent_id": null,
      "limit": 0
    },
    "cards": [
      {}
    ]
  },
  "meta": {
    "request_id": "req_sample",
    "timestamp": "1970-01-01T00:00:00.000Z"
  }
}

List coaching-rules

GET /api/v1/quality/coaching-rules

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/quality/coaching-rules" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/quality/coaching-rules', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/quality/coaching-rules", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/quality/coaching-rules", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/quality/coaching-rules')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/quality/coaching-rules');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": [
    {
      "rule_id": "qrl_3a5b7c9d1e3f5a7b9c1d3e5f",
      "name": "Gate-keepers greeting",
      "condition": {
        "field": "transcript",
        "contains": "greeting"
      },
      "action": "flag_for_coaching"
    }
  ],
  "meta": {
    "request_id": "req_01HZQX4E7JQ4M2E2H2DM9XE5FJ",
    "timestamp": "2026-08-26T12:00:00.000Z"
  }
}

Compliance-flagged QA evaluations queue

GET /api/v1/quality/compliance-flags

Newest-first list of official QA evaluations whose flagged_for_review bit is set — the auto-scorer’s below-threshold signals that need supervisor resolution. Reviewer scope (owner / admin / supervisor) may inspect any agent’s flags; a non-reviewer agent only ever sees their own. Read-only.

string

Look-back window in days over the evaluation’s creation time (1–90). Defaults to 30, capped at 90; an out-of-range or non-numeric value falls back to 30.

string

Restrict the queue to one agent. Defaults to every evaluated agent (or only the caller for non-reviewer users). An over-long value falls back to all agents.

string

Max flagged rows returned (1–100). Defaults to 50, clamped to 100; an out-of-range or non-numeric value falls back to 50.

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/quality/compliance-flags" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/quality/compliance-flags', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/quality/compliance-flags", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/quality/compliance-flags", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/quality/compliance-flags')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/quality/compliance-flags');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": {
    "window": {
      "days": 0,
      "agent_id": null,
      "limit": 0
    },
    "flags": [
      {}
    ]
  },
  "meta": {
    "request_id": "req_sample",
    "timestamp": "1970-01-01T00:00:00.000Z"
  }
}

Per-criterion QA driver averages

GET /api/v1/quality/drivers

Worst-first rollup of every scorecard criterion (rubric line) over official reviewer-authored QA evaluations — eval volume plus raw and normalised 0–100 averages per driver, labelled from the form definitions. Answers ‘which scorecard lines drive quality down’ on the scorecard pipeline; pairs with the per-day trend at GET /quality/trends. Self-evaluations and appealed/resolved rows are excluded so only current official scores drive the rollup. Read-only; requires an owner, admin, or supervisor role.

string

Look-back window in days over each evaluation’s creation time (1–90). Defaults to 30, capped at 90; an out-of-range or non-numeric value falls back to 30.

string

Restrict the rollup to a single scorecard form (rubric) id from /quality/evaluation-forms. Defaults to every form; an over-long value falls back to all forms.

string

Drill the driver rollup into one evaluated agent’s scores. Defaults to every agent; an over-long value falls back to all agents.

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/quality/drivers" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/quality/drivers', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/quality/drivers", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/quality/drivers", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/quality/drivers')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/quality/drivers');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": {
    "window": {
      "days": 0,
      "form_id": null,
      "agent_id": null
    },
    "totals": {
      "total_evals": 0,
      "active_forms": 0
    },
    "drivers": [
      {}
    ]
  },
  "meta": {
    "request_id": "req_sample",
    "timestamp": "1970-01-01T00:00:00.000Z"
  }
}

List evaluation forms

GET /api/v1/quality/evaluation-forms

List the tenant’s QA scorecard templates, most-recently-updated first. Filter with is_active to show only live rubrics, and cap the page size with limit. Reviewer scope (owner / admin / supervisor).

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/quality/evaluation-forms" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/quality/evaluation-forms', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/quality/evaluation-forms", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/quality/evaluation-forms", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/quality/evaluation-forms')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/quality/evaluation-forms');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": {
    "items": [
      {
        "id": "msg_3f6a81c2d4e5471a9b0c2d5e",
        "name": "string",
        "description": null,
        "definition": {},
        "is_active": false,
        "sample_rate_pct": 0,
        "created_by": null,
        "created_at": "1970-01-01T00:00:00.000Z",
        "updated_at": "1970-01-01T00:00:00.000Z"
      }
    ]
  },
  "meta": {
    "request_id": "req_sample",
    "timestamp": "1970-01-01T00:00:00.000Z"
  }
}

Get an evaluation form

GET /api/v1/quality/evaluation-forms/{id}

Fetch a single QA scorecard template by id, including its full weighted section/criteria definition. Use this to render the rubric before authoring an evaluation or to review a form’s configuration. Reviewer scope (owner / admin / supervisor).

string

required

—

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/quality/evaluation-forms/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/quality/evaluation-forms/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/quality/evaluation-forms/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/quality/evaluation-forms/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/quality/evaluation-forms/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/quality/evaluation-forms/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": {
    "id": "msg_3f6a81c2d4e5471a9b0c2d5e",
    "name": "string",
    "description": null,
    "definition": {},
    "is_active": false,
    "sample_rate_pct": 0,
    "created_by": null,
    "created_at": "1970-01-01T00:00:00.000Z",
    "updated_at": "1970-01-01T00:00:00.000Z"
  },
  "meta": {
    "request_id": "req_sample",
    "timestamp": "1970-01-01T00:00:00.000Z"
  }
}

List evaluations

GET /api/v1/quality/evaluations

List QA evaluations for the tenant with keyset pagination. Reviewer-scope callers may filter by any agent, call, reviewer, status, or provenance (auto-scored / flagged / CSAT-triggered / self vs reviewer); a non-reviewer agent only ever sees their own evaluations. Each row carries the derived evaluation_type and any linked CSAT score for the same call.

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/quality/evaluations" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/quality/evaluations', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/quality/evaluations", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/quality/evaluations", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/quality/evaluations')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/quality/evaluations');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": {
    "items": [
      {
        "id": "msg_3f6a81c2d4e5471a9b0c2d5e",
        "form_id": "string",
        "reviewer_id": "string",
        "agent_id": "string",
        "call_id": "call_8b2c4d6e1f3a5b7c9d0e2f4a",
        "scores": {},
        "total_score": 0,
        "status": "pending",
        "auto_scored": false,
        "flagged_for_review": false,
        "appeal_note": null,
        "acknowledged_at": null,
        "appealed_at": null,
        "resolved_at": null,
        "created_at": "1970-01-01T00:00:00.000Z",
        "updated_at": "1970-01-01T00:00:00.000Z",
        "evaluation_type": "self",
        "csat_score": null,
        "csat_channel": null,
        "csat_responded_at": null
      }
    ],
    "next_cursor": null
  },
  "meta": {
    "request_id": "req_sample",
    "timestamp": "1970-01-01T00:00:00.000Z"
  }
}

Compare self vs reviewer scores for a call

GET /api/v1/quality/evaluations/variance

Return the self-evaluation, the reviewer evaluation, and the per-criterion variance between them for a single call — the calibration gap that surfaces where an agent over- or under-rates their own work. call_id is required; un-graded auto-sampled / CSAT placeholder rows are excluded from the reviewer side. A non-reviewer agent only ever sees their own variance, while reviewer scope (owner / admin / supervisor) may pass agent_id to inspect any agent.

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/quality/evaluations/variance" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/quality/evaluations/variance', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/quality/evaluations/variance", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/quality/evaluations/variance", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/quality/evaluations/variance')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/quality/evaluations/variance');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": {
    "call_id": "call_8b2c4d6e1f3a5b7c9d0e2f4a",
    "agent_id": "string",
    "self": null,
    "reviewer": null,
    "variance": null
  },
  "meta": {
    "request_id": "req_sample",
    "timestamp": "1970-01-01T00:00:00.000Z"
  }
}

Per-evaluator QA assignment workload

GET /api/v1/quality/evaluations/workload

List every eligible evaluator (owner/admin) with their current open-assignment count, the tenant’s per-evaluator quota, remaining capacity, and how many of their open assignments are overdue against the tenant’s due-date window. Filter to one evaluator with evaluator_id. Reviewer scope (owner / admin / supervisor).

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/quality/evaluations/workload" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/quality/evaluations/workload', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/quality/evaluations/workload", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/quality/evaluations/workload", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/quality/evaluations/workload')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/quality/evaluations/workload');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": {
    "reviewers": [
      {
        "reviewer_id": "user_2x9v8wJ7kD3qR5mN1pA0",
        "pending": 14
      },
      {
        "reviewer_id": "user_9y3cM2bT4qK7sR1vX8uP",
        "pending": 3
      }
    ]
  },
  "meta": {
    "request_id": "req_01HZQX4E7JQ4M2E2H2DM9XE5FJ",
    "timestamp": "2026-08-26T12:00:00.000Z"
  }
}

Get gamification config defaults

GET /api/v1/quality/gamification/config

Return the default agent-engagement ruleset — the scorable metric keys, the point rules that convert KPIs into points, and the threshold badge definitions. Use this to render and pre-fill the supervisor config screen before tuning a ruleset and previewing it via the leaderboard endpoint. Reviewer scope (owner / admin / supervisor).

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/quality/gamification/config" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/quality/gamification/config', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/quality/gamification/config", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/quality/gamification/config", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/quality/gamification/config')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/quality/gamification/config');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": {
    "metric_keys": [
      "string"
    ],
    "point_rules": [
      {}
    ],
    "badge_definitions": [
      {}
    ]
  },
  "meta": {
    "request_id": "req_sample",
    "timestamp": "1970-01-01T00:00:00.000Z"
  }
}

Get my gamification card

GET /api/v1/quality/gamification/me

An agent reads THEIR OWN performance card — points, earned badges, and anonymised org rank — for a named lookback period (defaults to week). The rank is computed against the full org roster with the DEFAULT ruleset, identical to the supervisor default board, so an agent’s rank can never disagree with the supervisor view; only the caller’s own slice is returned, never another agent’s identity. Any authenticated agent scope: reviewer-scope roles (owner / admin / supervisor) may pass agent_id to inspect another agent, while a non-reviewer asking for someone else’s card gets a 403.

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/quality/gamification/me" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/quality/gamification/me', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

{
  "data": {
    "window": {
      "from": "1970-01-01T00:00:00.000Z",
      "to": "1970-01-01T00:00:00.000Z",
      "period": "day"
    },
    "rules_source": "default",
    "me": {
      "agentId": "string",
      "agentName": null,
      "rank": null,
      "totalAgents": 0,
      "totalPoints": 0,
      "breakdown": [
        {}
      ],
      "badges": [
        {}
      ],
      "metrics": {},
      "hasActivity": false
    }
  },
  "meta": {
    "request_id": "req_sample",
    "timestamp": "1970-01-01T00:00:00.000Z"
  }
}

Search the post-call recording/transcript library

GET /api/v1/quality/recording-library

List the tenant’s recordings with keyset pagination, optionally searching the finalised diarised transcript segments by substring and filtering by classification, transcription/QC status, score range, and QA provenance. Each hit carries the linked QA evaluation’s latest score and the recording QC verdict, plus the top transcript fragments matching q. Reviewer scope (owner / admin / supervisor) because both transcript content and cross-agent QA scores are surfaced.

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/quality/recording-library" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/quality/recording-library', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

{
  "data": {
    "items": [
      {}
    ],
    "next_cursor": null
  },
  "meta": {}
}

Org-wide quality-management summary

GET /api/v1/quality/summary

Cross-channel quality-management rollup for supervisors and admins — aggregates LLM-judged conversation outcomes across inbox and voice into one org-wide view. Returns overall totals (conversations scored, pass rate, average judge confidence), a per-channel breakdown, the top rubrics by evaluation volume with their pass rates, and the most recent low-confidence failures for triage. Use it to power a Quality Management overview page instead of navigating agent-by-agent. Read-only; requires an owner, admin, or supervisor role.

string

Look-back window in days over each outcome’s evaluation time (1–90). Defaults to 30, capped at 90; an out-of-range or non-numeric value falls back to 30.

string

Restrict the rollup to a single conversation channel — inbox, voice, or all for both. Defaults to all; any unrecognised value falls back to all.

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/quality/summary" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/quality/summary', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

{
  "data": {
    "window": {
      "days": 0,
      "conv_type": "inbox"
    },
    "totals": {
      "total_scored": 0,
      "total_outcomes": 0,
      "pass_rate": null,
      "avg_confidence": null
    },
    "by_channel": [
      {}
    ],
    "by_rubric": [
      {}
    ],
    "recent_failures": [
      {}
    ]
  },
  "meta": {
    "request_id": "req_sample",
    "timestamp": "1970-01-01T00:00:00.000Z"
  }
}

Org-wide QA score trend series

GET /api/v1/quality/trends

Time series of official reviewer-authored QA evaluation scores — per-day averages plus per-agent and per-scorecard-form breakdowns. Answers ‘is quality trending up?’ against the scorecard rubrics an org actually grades with; pairs with the point-in-time rollup at GET /quality/summary. Self-evaluations (agent scoring their own call) and appealed/resolved rows are excluded so only current official scores drive the trend. Read-only; requires an owner, admin, or supervisor role.

string

Look-back window in days over each evaluation’s creation time (1–90). Defaults to 30, capped at 90; an out-of-range or non-numeric value falls back to 30.

string

Restrict the trend to a single scorecard form (rubric) id from /quality/evaluation-forms. Defaults to every form; an over-long value falls back to all forms.

string

Drill the whole trend into one evaluated agent’s scores. Defaults to every agent; an over-long value falls back to all agents.

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/quality/trends" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/quality/trends', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

{
  "data": {
    "window": {
      "days": 0,
      "form_id": null,
      "agent_id": null
    },
    "totals": {
      "total_evals": 0,
      "avg_score": null,
      "scored_agents": 0,
      "active_forms": 0
    },
    "trend": [
      {}
    ],
    "by_agent": [
      {}
    ],
    "by_form": [
      {}
    ]
  },
  "meta": {
    "request_id": "req_sample",
    "timestamp": "1970-01-01T00:00:00.000Z"
  }
}

Create a calibration session

POST /api/v1/quality/calibrations

Open a QM calibration session pinned to one call and one evaluation form, and invite a roster of reviewers. The creator is always added to the roster. If the call already has an AI auto-scored evaluation against the same form, that score is copied in read-only as a drift baseline. Reviewer scope (owner / admin / supervisor).

string

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.

string (enum: true|false)

string

required

Evaluation form to calibrate against (must be active).

string

required

Call the roster will score.

string

Optional human-readable session title.

string[]

Invited reviewer ids. De-duplicated server-side; the creator is added implicitly.

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/quality/calibrations" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
  "form_id": "string",
  "call_id": "call_8b2c4d6e1f3a5b7c9d0e2f4a"
}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/quality/calibrations', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "form_id": "string",
  "call_id": "call_8b2c4d6e1f3a5b7c9d0e2f4a"
}),
})
console.log(await res.json())

{
  "data": {
    "id": "msg_3f6a81c2d4e5471a9b0c2d5e",
    "form_id": "string",
    "call_id": "call_8b2c4d6e1f3a5b7c9d0e2f4a",
    "title": null,
    "status": "open",
    "reviewer_ids": [
      "string"
    ],
    "ai_seeded": false,
    "created_at": "1970-01-01T00:00:00.000Z",
    "updated_at": "1970-01-01T00:00:00.000Z"
  },
  "meta": {
    "request_id": "req_sample",
    "timestamp": "1970-01-01T00:00:00.000Z"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "status": 0,
    "details": {}
  },
  "meta": {
    "request_id": "req_sample",
    "timestamp": "1970-01-01T00:00:00.000Z",
    "docs_url": "https://example.com"
  }
}

Close a calibration session

POST /api/v1/quality/calibrations/{id}/close

Close an open calibration session. Idempotency-guarded: closing an already-closed session returns 409. Reviewer scope (owner / admin / supervisor).

string

required

Calibration session identifier.

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/quality/calibrations/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/close" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/quality/calibrations/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/close', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "id": "msg_3f6a81c2d4e5471a9b0c2d5e",
    "status": "closed",
    "closed_at": "1970-01-01T00:00:00.000Z"
  },
  "meta": {
    "request_id": "req_sample",
    "timestamp": "1970-01-01T00:00:00.000Z"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "status": 0,
    "details": {}
  },
  "meta": {
    "request_id": "req_sample",
    "timestamp": "1970-01-01T00:00:00.000Z",
    "docs_url": "https://example.com"
  }
}

POST /api/v1/quality/calibrations/{id}/scores

Submit your blind score for a calibration session. One submission per reviewer — a second attempt returns 409. total_score is re-derived server-side from the form weights; clients cannot supply it. The session must be open and you must be an invited reviewer. Reviewer scope (owner / admin / supervisor).

string

required

Calibration session identifier.

string

string (enum: true|false)

object

required

Map of criterion_id → raw score (0–100). The server re-derives the weighted total against the form definition.

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/quality/calibrations/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/scores" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
  "scores": {}
}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/quality/calibrations/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/scores', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "scores": {}
}),
})
console.log(await res.json())

{
  "data": {
    "id": "msg_3f6a81c2d4e5471a9b0c2d5e",
    "session_id": "string",
    "reviewer_id": "string",
    "scores": {},
    "total_score": 0,
    "submitted_at": "1970-01-01T00:00:00.000Z"
  },
  "meta": {
    "request_id": "req_sample",
    "timestamp": "1970-01-01T00:00:00.000Z"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "status": 0,
    "details": {}
  },
  "meta": {
    "request_id": "req_sample",
    "timestamp": "1970-01-01T00:00:00.000Z",
    "docs_url": "https://example.com"
  }
}

Create an evaluation form

POST /api/v1/quality/evaluation-forms

Create a QA scorecard template — the weighted sections and criteria a reviewer grades a call against. Use this to author a new rubric before any evaluations can be scored against it; set sample_rate_pct above 0 to have the auto-sampler queue a share of each agent’s calls for review. Reviewer scope (owner / admin / supervisor).

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/quality/evaluation-forms" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/quality/evaluation-forms', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "id": "msg_3f6a81c2d4e5471a9b0c2d5e",
    "name": "string",
    "description": null,
    "definition": {},
    "is_active": false,
    "sample_rate_pct": 0,
    "created_by": null,
    "created_at": "1970-01-01T00:00:00.000Z",
    "updated_at": "1970-01-01T00:00:00.000Z"
  },
  "meta": {
    "request_id": "req_sample",
    "timestamp": "1970-01-01T00:00:00.000Z"
  }
}

Create an evaluation

POST /api/v1/quality/evaluations

Author a reviewer evaluation of one agent’s call against a scorecard form. Post per-criterion raw scores (criterion id → 0..100); the server re-derives the weighted total_score from the form so clients cannot inflate the rollup. The row lands pending for the agent to acknowledge or appeal. Reviewer scope (owner / admin / supervisor).

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/quality/evaluations" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/quality/evaluations', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "id": "msg_3f6a81c2d4e5471a9b0c2d5e",
    "form_id": "string",
    "reviewer_id": "string",
    "agent_id": "string",
    "call_id": "call_8b2c4d6e1f3a5b7c9d0e2f4a",
    "scores": {},
    "total_score": 0,
    "status": "pending",
    "created_at": "1970-01-01T00:00:00.000Z",
    "updated_at": "1970-01-01T00:00:00.000Z"
  },
  "meta": {
    "request_id": "req_sample",
    "timestamp": "1970-01-01T00:00:00.000Z"
  }
}

Acknowledge an evaluation

POST /api/v1/quality/evaluations/{id}/acknowledge

The evaluated agent acknowledges a reviewer’s score, moving it from pending to acknowledged. Only the agent named on the evaluation may acknowledge it; already-acknowledged rows are idempotent. No request body.

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/quality/evaluations/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/acknowledge" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/quality/evaluations/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/acknowledge', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "id": "msg_3f6a81c2d4e5471a9b0c2d5e",
    "status": "acknowledged",
    "acknowledged_at": "1970-01-01T00:00:00.000Z"
  },
  "meta": {
    "request_id": "req_sample",
    "timestamp": "1970-01-01T00:00:00.000Z"
  }
}

Appeal an evaluation

POST /api/v1/quality/evaluations/{id}/appeal

The evaluated agent appeals a reviewer’s score with a written note, moving it to appealed for a supervisor to resolve. Only the agent named on the evaluation may appeal, and only while it is pending or acknowledged.

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/quality/evaluations/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/appeal" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/quality/evaluations/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/appeal', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "id": "msg_3f6a81c2d4e5471a9b0c2d5e",
    "status": "appealed",
    "appealed_at": "1970-01-01T00:00:00.000Z",
    "appeal_note": "string"
  },
  "meta": {
    "request_id": "req_sample",
    "timestamp": "1970-01-01T00:00:00.000Z"
  }
}

Claim and score an auto-queued evaluation

POST /api/v1/quality/evaluations/{id}/claim-score

A reviewer picks up a system-queued placeholder evaluation (auto-sampled or CSAT-triggered, still un-graded at score 0) and fills in the real per-criterion scores. The server re-derives total_score from the form weights and stamps the reviewer as the author; status stays pending so the agent’s acknowledge/appeal flow proceeds on a real score. Human-authored rows cannot be claimed. Reviewer scope (owner / admin / supervisor).

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/quality/evaluations/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/claim-score" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/quality/evaluations/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/claim-score', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "id": "msg_3f6a81c2d4e5471a9b0c2d5e",
    "reviewer_id": "string",
    "scores": {},
    "total_score": 0,
    "status": "pending",
    "updated_at": "1970-01-01T00:00:00.000Z"
  },
  "meta": {
    "request_id": "req_sample",
    "timestamp": "1970-01-01T00:00:00.000Z"
  }
}

Override an AI-scored evaluation

POST /api/v1/quality/evaluations/{id}/override

A reviewer corrects an AI/auto-scored evaluation by replacing its per-criterion scores with their own. The server re-derives total_score from the form weights, stamps the reviewer as the author, and clears the review flag. Only a pending, auto-scored row may be overridden — human-authored or already-corrected evaluations return 409. Reviewer scope (owner / admin / supervisor).

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/quality/evaluations/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/override" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/quality/evaluations/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/override', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "id": "msg_3f6a81c2d4e5471a9b0c2d5e",
    "reviewer_id": "string",
    "scores": {},
    "total_score": 0,
    "status": "pending",
    "auto_scored": false,
    "flagged_for_review": false,
    "updated_at": "1970-01-01T00:00:00.000Z"
  },
  "meta": {
    "request_id": "req_sample",
    "timestamp": "1970-01-01T00:00:00.000Z"
  }
}

Reassign an open evaluation to a different evaluator

POST /api/v1/quality/evaluations/{id}/reassign

Move an existing OPEN (pending, unscored) evaluation-assignment queue item to a different assignee_id — workload rebalancing. Only an unscored pending row may be reassigned (409 INVALID_STATE otherwise); the new assignee is subject to the same per-evaluator quota as POST /evaluations/assign. Reviewer scope (owner / admin / supervisor).

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/quality/evaluations/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/reassign" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/quality/evaluations/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/reassign', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "evaluation_id": "qev_1c3e5a7b9d1f3a5b7c9d1e3a",
    "reviewer_id": "user_9y3cM2bT4qK7sR1vX8uP"
  },
  "meta": {
    "request_id": "req_01HZQX4E7JQ4M2E2H2DM9XE5FJ",
    "timestamp": "2026-08-26T12:00:00.000Z"
  }
}

Resolve an appealed evaluation

POST /api/v1/quality/evaluations/{id}/resolve

A supervisor closes an appealed evaluation, moving it from appealed to resolved with an optional resolution note. Resolving closes the appeal; it does NOT regrade the call (total_score is left untouched). Only an appealed evaluation may be resolved. Reviewer scope (owner / admin / supervisor).

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/quality/evaluations/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/resolve" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/quality/evaluations/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/resolve', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "id": "msg_3f6a81c2d4e5471a9b0c2d5e",
    "status": "resolved",
    "resolved_at": "1970-01-01T00:00:00.000Z"
  },
  "meta": {
    "request_id": "req_sample",
    "timestamp": "1970-01-01T00:00:00.000Z"
  }
}

Assign a QA evaluation to a specific evaluator

POST /api/v1/quality/evaluations/assign

Create a new OPEN evaluation-assignment queue item for call_id against form_id, naming assignee_id as the reviewer. Rejects with 409 QUOTA_EXCEEDED if the assignee already holds the tenant’s per-evaluator open-assignment cap, and 409 ALREADY_ASSIGNED if the call already has an open (unscored) row. The row lands pending/unscored — the assignee fills in scores via the existing claim-score flow. Reviewer scope (owner / admin / supervisor).

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/quality/evaluations/assign" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/quality/evaluations/assign', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "assigned": [
      {
        "evaluation_id": "qev_1c3e5a7b9d1f3a5b7c9d1e3a",
        "reviewer_id": "user_2x9v8wJ7kD3qR5mN1pA0"
      }
    ]
  },
  "meta": {
    "request_id": "req_01HZQX4E7JQ4M2E2H2DM9XE5FJ",
    "timestamp": "2026-08-26T12:00:00.000Z"
  }
}

Create a self-evaluation

POST /api/v1/quality/evaluations/self

An agent grades their OWN call against a scorecard form. Post per-criterion raw scores (criterion id → 0..100); the server re-derives the weighted total_score from the form so the rollup cannot be inflated. The handler always stamps agent_id = reviewer_id to the caller, so an agent can only ever self-evaluate their own work, and the row lands acknowledged (no reviewer sign-off needed). Any authenticated agent scope.

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/quality/evaluations/self" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/quality/evaluations/self', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "id": "msg_3f6a81c2d4e5471a9b0c2d5e",
    "form_id": "string",
    "reviewer_id": "string",
    "agent_id": "string",
    "call_id": "call_8b2c4d6e1f3a5b7c9d0e2f4a",
    "scores": {},
    "total_score": 0,
    "status": "acknowledged",
    "evaluation_type": "self",
    "created_at": "1970-01-01T00:00:00.000Z",
    "updated_at": "1970-01-01T00:00:00.000Z"
  },
  "meta": {
    "request_id": "req_sample",
    "timestamp": "1970-01-01T00:00:00.000Z"
  }
}

Compute the agent leaderboard

POST /api/v1/quality/gamification/leaderboard

Compute the ranked agent leaderboard for a window and scope from existing QA, call-volume and CSAT aggregates. Narrow to a team with queue_id or an explicit agent_ids allow-list, and override point_rules / badge_definitions to preview a tuned ruleset before adopting it. Supervisors are limited to their mapped queues. Reviewer scope (owner / admin / supervisor).

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/quality/gamification/leaderboard" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/quality/gamification/leaderboard', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "window": {
      "from": "1970-01-01T00:00:00.000Z",
      "to": "1970-01-01T00:00:00.000Z",
      "period": "day"
    },
    "scope": {
      "queue_id": null,
      "agent_ids": null
    },
    "rules_source": "default",
    "entries": [
      {}
    ]
  },
  "meta": {
    "request_id": "req_sample",
    "timestamp": "1970-01-01T00:00:00.000Z"
  }
}

Compute a weighted supervisor scorecard

POST /api/v1/quality/scorecards/composite

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).

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/quality/scorecards/composite" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/quality/scorecards/composite', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "window": {
      "from": "1970-01-01T00:00:00.000Z",
      "to": "1970-01-01T00:00:00.000Z",
      "period": "day"
    },
    "scope": {
      "queue_id": null,
      "agent_ids": null
    },
    "kpi_registry": [
      {}
    ],
    "results": [
      {}
    ]
  },
  "meta": {
    "request_id": "req_sample",
    "timestamp": "1970-01-01T00:00:00.000Z"
  }
}

Update an evaluation form

PATCH /api/v1/quality/evaluation-forms/{id}

Partially update a QA scorecard template — rename it, replace its weighted definition, toggle is_active, or change sample_rate_pct. Only the fields you send are changed; at least one field is required. Reviewer scope (owner / admin / supervisor).

string

required

—

string (enum: true|false)

cURL

curl -X PATCH "https://api.orbit.devotel.io/api/v1/quality/evaluation-forms/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/quality/evaluation-forms/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3', {
  method: 'PATCH',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "id": "msg_3f6a81c2d4e5471a9b0c2d5e",
    "updated": false
  },
  "meta": {
    "request_id": "req_sample",
    "timestamp": "1970-01-01T00:00:00.000Z"
  }
}

API Reference

All Endpoints

Quality API

Quality API

QA score trend series

List auto-qa-readiness

AI auto-QA coverage rollup

List calibration sessions

Get a calibration session

Get the calibration agreement report

Per-agent coaching cards

List coaching-rules

Compliance-flagged QA evaluations queue

Per-criterion QA driver averages

List evaluation forms

Get an evaluation form

List evaluations

Compare self vs reviewer scores for a call

Per-evaluator QA assignment workload

Get gamification config defaults

Get my gamification card

Search the post-call recording/transcript library

Org-wide quality-management summary

Org-wide QA score trend series

Create a calibration session

Close a calibration session

Submit a blind calibration score

Create an evaluation form

Create an evaluation

Acknowledge an evaluation

Appeal an evaluation

Claim and score an auto-queued evaluation

Override an AI-scored evaluation

Reassign an open evaluation to a different evaluator

Resolve an appealed evaluation

Assign a QA evaluation to a specific evaluator

Create a self-evaluation

Compute the agent leaderboard

Compute a weighted supervisor scorecard

Update an evaluation form

​Quality API

​QA score trend series

​List auto-qa-readiness

​AI auto-QA coverage rollup

​List calibration sessions

​Get a calibration session

​Get the calibration agreement report

​Per-agent coaching cards

​List coaching-rules

​Compliance-flagged QA evaluations queue

​Per-criterion QA driver averages

​List evaluation forms

​Get an evaluation form

​List evaluations

​Compare self vs reviewer scores for a call

​Per-evaluator QA assignment workload

​Get gamification config defaults

​Get my gamification card

​Search the post-call recording/transcript library

​Org-wide quality-management summary

​Org-wide QA score trend series

​Create a calibration session

​Close a calibration session

​Submit a blind calibration score

​Create an evaluation form

​Create an evaluation

​Acknowledge an evaluation

​Appeal an evaluation

​Claim and score an auto-queued evaluation

​Override an AI-scored evaluation

​Reassign an open evaluation to a different evaluator

​Resolve an appealed evaluation

​Assign a QA evaluation to a specific evaluator

​Create a self-evaluation

​Compute the agent leaderboard

​Compute a weighted supervisor scorecard

​Update an evaluation form

Quality API

QA score trend series

List auto-qa-readiness

AI auto-QA coverage rollup

List calibration sessions

Get a calibration session

Get the calibration agreement report

Per-agent coaching cards

List coaching-rules

Compliance-flagged QA evaluations queue

Per-criterion QA driver averages

List evaluation forms

Get an evaluation form

List evaluations

Compare self vs reviewer scores for a call

Per-evaluator QA assignment workload

Get gamification config defaults

Get my gamification card

Search the post-call recording/transcript library

Org-wide quality-management summary

Org-wide QA score trend series

Create a calibration session

Close a calibration session

Submit a blind calibration score

Create an evaluation form

Create an evaluation

Acknowledge an evaluation

Appeal an evaluation

Claim and score an auto-queued evaluation

Override an AI-scored evaluation

Reassign an open evaluation to a different evaluator

Resolve an appealed evaluation

Assign a QA evaluation to a specific evaluator

Create a self-evaluation

Compute the agent leaderboard

Compute a weighted supervisor scorecard

Update an evaluation form