Skip to content
NorthplaneNorthplane

Wallboard counters

GET
/api/v1/overview
curl --request GET \
  --url https://example.com/api/v1/overview \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
openAlerts
required
object
key
additional properties
integer
openIncidents
required
Array<object>
object
createdBy
required
string
id
required
string
impact
string
openedAt
required
string format: date-time
resolvedAt
string format: date-time
severity
required
string
status
required
string
summary
string
tenantId
required
string
ticketUrl
string
title
required
string
version
required
integer
queues
required
object
aiDepth
required
integer
droppedAi
required
integer
droppedSubscriberMessages
required
integer
eventsDepth
required
integer
notifyDepth
required
integer
resultsDepth
required
integer
subscribers
required
integer
summary
object
acked
required
integer
flapping
required
integer
hostsDown
required
integer
hostsUnreachable
required
integer
hostsUp
required
integer
inDowntime
required
integer
servicesCritical
required
integer
servicesOk
required
integer
servicesUnknown
required
integer
servicesWarning
required
integer
Examplegenerated
{
  "openAlerts": {
    "additionalProperty": 1
  },
  "openIncidents": [
    {
      "createdBy": "example",
      "id": "example",
      "impact": "example",
      "openedAt": "2026-04-15T12:00:00Z",
      "resolvedAt": "2026-04-15T12:00:00Z",
      "severity": "example",
      "status": "example",
      "summary": "example",
      "tenantId": "example",
      "ticketUrl": "example",
      "title": "example",
      "version": 1
    }
  ],
  "queues": {
    "aiDepth": 1,
    "droppedAi": 1,
    "droppedSubscriberMessages": 1,
    "eventsDepth": 1,
    "notifyDepth": 1,
    "resultsDepth": 1,
    "subscribers": 1
  },
  "summary": {
    "acked": 1,
    "flapping": 1,
    "hostsDown": 1,
    "hostsUnreachable": 1,
    "hostsUp": 1,
    "inDowntime": 1,
    "servicesCritical": 1,
    "servicesOk": 1,
    "servicesUnknown": 1,
    "servicesWarning": 1
  }
}

default

Section titled “default”

Problem Details (RFC 9457)

Media typeapplication/problem+json
object
code
required
string
detail
string
instance
string
status
required
integer
title
required
string
type
required
string
Examplegenerated
{
  "code": "example",
  "detail": "example",
  "instance": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}