Skip to main content
GET
Get client benchmarks

Authorizations

Authorization
string
header
required

Use your API key as a Bearer token. API keys can be generated in Settings → Integrations → API Access.

Query Parameters

companyId
string<uuid>

Benchmark one company

metric
enum<string>[]

Metrics to return, in order, each at most once (repeat the key or comma-separate; default health, patch, backup)

Available options:
health,
patch,
backup
order
enum<string>
default:asc

Client order by value; asc lists the lowest first

Available options:
asc,
desc
limit
integer
default:25

Most clients per metric

Required range: 1 <= x <= 100

Response

Benchmarks

data
object
required

Metrics the caller cannot read are left out; peer figures are null below the minimum peer count.