Skip to main content
GET
/
notifications
/
api
/
v1
/
notifications
/
health
Notification system health
curl --request GET \
  --url https://www.closient.com/notifications/api/v1/notifications/health \
  --header 'X-API-Key: <api-key>'
{
  "last_hour": {},
  "last_24h": {}
}

Authorizations

​
X-API-Key
string
header
required

Response

200 - application/json

OK

Aggregate health snapshot of the notification delivery pipeline.

Returned by GET /health. Used by uptime monitors and the internal ops dashboard to decide whether the pipeline is keeping up with its queue. The two time-window buckets are dynamic-shape JSON because the underlying monitor returns different metrics per window:

  • last_hour — keys deliveries (per-status counts) and performance (failure rate, throughput).
  • last_24h — keys unsubscribes (counts by source).
​
status
enum<string>
required

Aggregate health verdict. Computed from trailing-hour failure rate.

Available options:
healthy,
degraded,
unhealthy
​
last_hour
Last Hour · object
required

Delivery counters for the trailing 1-hour window. Keys: deliveries (counts by status), performance (failure rate, throughput).

​
last_24h
Last 24H · object
required

Activity counters for the trailing 24-hour window. Keys: unsubscribes (counts by source).