Skip to content
BookendBookend Docs

Get the dashboard

GET
/v1/dashboard
curl --request GET \
  --url http://localhost:8080/v1/dashboard

Metrics derived from recorded events and current loan rows, never synthetic: queue counts per state, daily throughput (created, reached review, approved) over days (default 30, clamped to 1–365), average review minutes, exception rate per rule and the age distribution of packages in review. Any staff role or an API key with status:read.

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
days
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
generatedAt
required
string format: date-time
windowDays
required
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
queue
required
object
intake
required
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
processing
required
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
review
required
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
approved
required
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
withExceptions
required
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
throughput
required
Array<object>

Per calendar day (UTC): packages created, packages that reached review, packages approved.

object
day
required
string
created
required
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
reachedReview
required
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
approved
required
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
averageReviewMinutes
required
null | number | string format: double
/^-?(?:0|[1-9]\d*)(?:\.\d+)?$/
reviewsMeasured
required
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
exceptionRateByRule
required
Array<object>

How often a rule raised a finding per reconciliation run in the window.

object
ruleId
required
string
severity
required
string
findings
required
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
runs
required
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
rate
required
number | string format: double
/^-?(?:0|[1-9]\d*)(?:\.\d+)?$/
aging
required
Array<object>
object
bucket
required
string
count
required
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
Examplegenerated
{
  "generatedAt": "2026-04-15T12:00:00Z",
  "windowDays": 1,
  "queue": {
    "intake": 1,
    "processing": 1,
    "review": 1,
    "approved": 1,
    "withExceptions": 1
  },
  "throughput": [
    {
      "day": "example",
      "created": 1,
      "reachedReview": 1,
      "approved": 1
    }
  ],
  "averageReviewMinutes": 1,
  "reviewsMeasured": 1,
  "exceptionRateByRule": [
    {
      "ruleId": "example",
      "severity": "example",
      "findings": 1,
      "runs": 1,
      "rate": 1
    }
  ],
  "aging": [
    {
      "bucket": "example",
      "count": 1
    }
  ]
}