GET
/
status
/
api
/
health
/
{service}
Get Service Health
curl --request GET \
  --url https://getbill.io/status/api/health/{service} \
  --header 'Authorization: Bearer <token>'
{
  "status": "operational",
  "responseTime": 12,
  "message": "API is responding normally"
}

Overview

Returns detailed health metrics for a specific GetBill service.

Authentication

None required. This is a public endpoint.

Request

service
string
required
Service identifier. One of: api, webapp, ai-calls, messaging

Example Request

curl -X GET "https://getbill.io/status/api/health/api" \
  -H "Accept: application/json"

Response

Response fields vary by service:

API Service

status
string
operational, degraded, or outage
responseTime
integer
Database response time in milliseconds
message
string
Human-readable status message

Web Application

status
string
operational, degraded, or outage
responseTime
integer
Response time in milliseconds
memoryUsage
number
Memory usage in MB
memoryPercent
number
Memory usage as percentage of limit

AI Calls

status
string
operational, degraded, or outage
successRate
number
Call success rate over last 24 hours (%)
totalCalls24h
integer
Total completed calls in last 24 hours

Messaging

status
string
operational, degraded, or outage
deliveryRate
number
Message delivery rate over last 24 hours (%)
queueTime
string
Estimated queue processing time
queueSize
integer
Number of messages pending delivery

Success Response

{
  "status": "operational",
  "responseTime": 12,
  "message": "API is responding normally"
}

Error Responses

{
  "error": "Service not found"
}

Available Services

ServiceDescription
apiCore API and database connectivity
webappWeb application and PHP runtime
ai-callsAI-powered voice calling services
messagingEmail, SMS, WhatsApp, and RCS messaging