Health Check

The health check endpoint reports the current status of the Chippy Analytics service and its dependencies. Use it to power monitoring dashboards, configure alerting, or run pre-deployment verification.

GET /api/v1/health

This endpoint does not require authentication. You can call it from any monitoring tool without an API key.

Example Request

curl https://analytics.chippy.build/api/v1/health

const response = await fetch("https://analytics.chippy.build/api/v1/health");
const health = await response.json();
console.log(health.status);

import requests

response = requests.get("https://analytics.chippy.build/api/v1/health")
health = response.json()
print(health["status"])

Response

200 OK: service is healthy:

{
  "status": "healthy",
  "timestamp": "2026-02-09T12:00:00Z",
  "version": "1.0.0",
  "checks": {
    "postgres": {
      "status": "healthy",
      "latency": 5
    },
    "redis": {
      "status": "healthy"
    }
  },
  "metrics": {
    "eventBufferSize": 42
  }
}

503 Service Unavailable: service is unhealthy:

{
  "status": "unhealthy",
  "timestamp": "2026-02-09T12:05:00Z",
  "version": "1.0.0",
  "checks": {
    "postgres": {
      "status": "unhealthy",
      "latency": 5023
    },
    "redis": {
      "status": "healthy"
    }
  },
  "metrics": {
    "eventBufferSize": 8491
  }
}

Response Fields

Field	Type	Description
`status`	string	Overall service status: `healthy`, `degraded`, or `unhealthy`
`timestamp`	string	ISO 8601 timestamp of the health check
`version`	string	Current API version
`checks`	object	Status of individual dependencies
`checks.<name>.status`	string	Dependency status: `healthy`, `degraded`, or `unhealthy`
`checks.<name>.latency`	number	Response time in milliseconds (when available)
`metrics`	object	Operational metrics
`metrics.eventBufferSize`	number	Number of events currently buffered for processing

Status Values

Status	HTTP Code	Meaning
`healthy`	200	All systems operating normally
`degraded`	200	Service is functional but one or more dependencies are slow or partially impaired
`unhealthy`	503	Service cannot process requests reliably

Use Cases

Monitoring dashboards

Poll the health endpoint at a regular interval (e.g., every 30 seconds) and display the overall status and individual component checks on your infrastructure dashboard.

# Quick status check from a cron job or monitoring script
curl -s https://analytics.chippy.build/api/v1/health | jq '.status'

Alerting

Set up alerts that trigger when the endpoint returns a non-200 status code or when status is anything other than healthy.

# Exit with non-zero code if unhealthy (useful for alerting scripts)
STATUS=$(curl -s -o /dev/null -w "%{http_code}" https://analytics.chippy.build/api/v1/health)
if [ "$STATUS" -ne 200 ]; then
  echo "Analytics service is unhealthy (HTTP $STATUS)"
  exit 1
fi

Pre-deployment checks

Verify that the analytics service is healthy before deploying a new version of your app that depends on event tracking.

The health endpoint reflects real-time status. A degraded response means events are still being accepted but may experience higher latency. Only unhealthy indicates that event processing is unreliable.

​Health Check

​GET /api/v1/health

​Example Request

​Response

​Response Fields

​Status Values

​Use Cases

​Monitoring dashboards

​Alerting

​Pre-deployment checks

Health Check

GET /api/v1/health

Example Request

Response

Response Fields

Status Values

Use Cases

Monitoring dashboards

Alerting

Pre-deployment checks