Skip to main content
GET
/
health
/
detailed
Detailed health
curl --request GET \
  --url https://api.example.com/health/detailed

​
Overview

Returns the health status of the CauseFlow API and all backing services, including latency measurements. Use this endpoint for monitoring and alerting on CauseFlow API availability.
This is a public endpoint. No authentication required. Use this for monitoring and alerting on CauseFlow API availability.

​
Response

Returns 200 OK with a detailed breakdown of each backing service. Note that the HTTP status is 200 regardless of whether services are degraded or unhealthy — inspect the status field in the response body to determine actual health. 
{
  "status": "healthy",
  "services": {
    "dynamodb": {
      "status": "healthy",
      "latencyMs": 4
    },
    "redis": {
      "status": "healthy",
      "latencyMs": 1
    },
    "sqs": {
      "status": "healthy",
      "latencyMs": 12
    }
  }
}
Example with a degraded service: 
{
  "status": "degraded",
  "services": {
    "dynamodb": {
      "status": "healthy",
      "latencyMs": 5
    },
    "redis": {
      "status": "degraded",
      "latencyMs": 320
    },
    "sqs": {
      "status": "healthy",
      "latencyMs": 14
    }
  }
}
FieldTypeDescription
statusstringOverall API health: healthy, degraded, or unhealthy
services.dynamodb.statusstringDynamoDB status: healthy, degraded, or unhealthy
services.dynamodb.latencyMsintegerRound-trip latency to DynamoDB in milliseconds
services.redis.statusstringRedis status: healthy, degraded, or unhealthy
services.redis.latencyMsintegerRound-trip latency to Redis in milliseconds
services.sqs.statusstringSQS status: healthy, degraded, or unhealthy
services.sqs.latencyMsintegerRound-trip latency to SQS in milliseconds
Status definitions:
StatusMeaning
healthyService is responding normally within expected latency thresholds
degradedService is responding but with elevated latency or intermittent errors
unhealthyService is not responding or returning errors on all requests

​
Examples

curl https://api.causeflow.ai/health/detailed