curl --silent --show-error --fail-with-body --request GET \
--url 'https://api.stateset.com/health/deep' \
--header "Authorization: Bearer $STATESET_API_KEY"
{
"status": "pending",
"database": {
"connected": true,
"latency_ms": 250
},
"metrics": {
"orders_created": 1,
"customers_created": 1,
"products_created": 1,
"payments_completed": 1
}
}
Deep health
deep health check with DB connectivity and metrics
GET
/
health
/
deep
curl --silent --show-error --fail-with-body --request GET \
--url 'https://api.stateset.com/health/deep' \
--header "Authorization: Bearer $STATESET_API_KEY"
{
"status": "pending",
"database": {
"connected": true,
"latency_ms": 250
},
"metrics": {
"orders_created": 1,
"customers_created": 1,
"products_created": 1,
"payments_completed": 1
}
}
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.
Response
object
string
required
Always
ok when the check passes.object
required
object
required
Show metrics
Show metrics
integer (int64)
required
Number of order creation events since start. Minimum:
0.integer (int64)
required
Number of customer creation events since start. Minimum:
0.integer (int64)
required
Number of product creation events since start. Minimum:
0.integer (int64)
required
Number of completed payment events since start. Minimum:
0.Status codes
| Code | Meaning |
|---|---|
200 | Deep health report with DB latency and engine counters |
500 | Database connectivity check failed |
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.curl --silent --show-error --fail-with-body --request GET \
--url 'https://api.stateset.com/health/deep' \
--header "Authorization: Bearer $STATESET_API_KEY"
{
"status": "pending",
"database": {
"connected": true,
"latency_ms": 250
},
"metrics": {
"orders_created": 1,
"customers_created": 1,
"products_created": 1,
"payments_completed": 1
}
}
Last modified on September 21, 2026