Skip to main content
GET
The metrics a board can be ranked by. Clients should build their columns from this rather than hardcoding a list, so changing the headline set needs no frontend deploy.

Authorizations

X-CB-KEY
string
header
required

CloseBot API Key Authorization

Response

OK

key
string | null
required

Wire key to pass as metric on GET /leaderboard/board.

label
string | null
required

Display name.

description
string | null
required

What the metric counts, and anything it deliberately excludes.

format
string | null
required

How to render the value: integer, decimal, duration (milliseconds), currency (USD), or score (0-100).

higherIsBetter
boolean
required

False when the board ranks ascending — cost, latency and error metrics, where #1 means least rather than most. Clients should say so next to the metric; a user who assumes "more is better" will read an AI-errors board exactly backwards.

supportsSourceScope
boolean
required

False for agency-wide metrics. Requesting scope=source for one of these is a 400.

isHeadline
boolean
required

True for the metrics the board actually surfaces — the radar's axes and the table's columns, in the order they appear here. Everything else is still ranked and stored, just not shown.

guidance
string | null

One sentence on how to move this metric, for the board's headline figure.

Null outside the headline set, and clients must render nothing rather than an empty line — widening Headline before its copy is written should degrade to silence, not to a stray label.