Skip to content

API & reference

Kpi

GET
/ratchet/kpis
curl --request GET \
--url http://localhost:8000/ratchet/kpis

The success metrics and the latency target, each with its value, target, whether it is met (None when there is not enough data yet) and the counts behind it, computed from the ledger as in the simulator. The first three metrics and the latency target use the last days ledger days with traffic (default RATCHET_KPI_WINDOW_DAYS). Public, like /ratchet/stats; simulated is true in mock mode, where every number comes from mock models.

days
Any of:
integer

Successful Response

Media typeapplication/json
Response Kpi Ratchet Kpis Get
object

Example generated

{}

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string

Example generated

{
"detail": [
{
"loc": [
"example"
],
"msg": "example",
"type": "example"
}
]
}