Skip to main content
GET
Confirm your deployment before running this request. This page describes an API contract; a published reference does not establish hosted availability. Check the dated host report and obtain your deployment URL and credentials. Replace the example host if your provisioned service uses a different URL.
Extended operational health beyond the basic liveness ping. Tenant-scoped: the failure-rate signal reflects this tenant’s jobs only, not the whole platform. Useful for dashboards that want a one-stop ‘is my integration healthy right now?’ panel.

Response

HealthDetailResponse
string
required
Aggregate signal: ok when nothing’s flagged, degraded when in-flight count or failure rate crosses warning thresholds, unhealthy when the DB itself is unreachable. Allowed values: 'ok', 'degraded', 'unhealthy'.
integer
required
integer
required
integer
required
number
required
failed / (succeeded + failed) over the last hour. 0.0 when no terminal jobs landed in that window — does not signal health by itself, callers should weigh total_last_hour first.
integer
required
string,null
ISO 8601 of when the calling API key was previously used. Useful for ops dashboards showing key activity timelines.
string
required

Status codes

Using this contract

Read the source OpenAPI document for declared schemas and alternatives. This page also includes documented corrections from the spec overlays. Example IDs and values are illustrative; replace them with records from your workspace.
Last modified on August 31, 2026