ETERA API Documentation

const url = 'https://api.etera.dev/restaurant/booking/providers/health';
const options = {method: 'GET'};
try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

{
  "success": true,
  "overall": true,
  "providers": [
    {
      "type": "opentable",
      "name": "OpenTable",
      "healthy": true,
      "responseTime": 340,
      "successRate": 0.99,
      "errorCount": 0,
      "lastCheck": "2024-02-15T10:30:00Z"
    },
    {
      "type": "vapi",
      "name": "VAPI AI Calling",
      "healthy": true,
      "responseTime": 8500,
      "successRate": 0.87,
      "errorCount": 2,
      "lastCheck": "2024-02-15T10:30:00Z"
    }
  ],
  "summary": {
    "total": 2,
    "healthy": 2,
    "degraded": 0,
    "offline": 0
  },
  "timestamp": "2024-02-15T10:30:00Z"
}

🏥 Global Provider Health Monitoring

Check the health status of all booking providers across the entire platform. This endpoint provides a system-wide view of provider performance and availability.

🔍 Health Metrics

System-Wide Status

Overall Health: Whether the booking system is operational
Provider Availability: How many providers are currently working
Performance Trends: Response times and success rates across providers

Individual Provider Status

Healthy: Provider is responding and performing well
Degraded: Provider is working but with reduced performance
Offline: Provider is not responding or severely impaired

🎯 Use Cases

Operations Dashboard: Monitor overall system health
Incident Response: Quickly identify system-wide issues
Capacity Planning: Understand overall booking capacity
SLA Monitoring: Track service level agreement compliance

📊 Response Details

Returns comprehensive health information for all providers, including performance metrics and current status.

Response

Global health check completed

successbooleanOptional

overallbooleanOptional

Overall system health

providerslist of objectsOptional

summaryobjectOptional

timestampdatetimeOptional