Skip to navigation

Get Provider Status

๐Ÿ”Œ Multi-Provider Status & Health Monitoring

Get comprehensive status information for all booking providers configured for a specific restaurant. This endpoint provides real-time health checks, performance metrics, and operational status.

๐Ÿš€ Provider Overview

Supported Providers

  • ๐Ÿ”— OpenTable - Direct API integration with instant confirmations
  • ๐Ÿ“ž VAPI AI Phone Calling - VAPI-powered automated restaurant calls
  • ๐Ÿช TableCheck - Platform integration for wider restaurant network
  • ๐Ÿ  Internal System - Restaurantโ€™s proprietary booking system

Health Metrics

  • Response Time: Average API response time over last 24 hours
  • Success Rate: Successful bookings vs attempts (%)
  • Error Count: Recent failures and error types
  • Last Error: Most recent error message for debugging
  • Bookings Handled: Total bookings processed by each provider

๐ŸŽฏ Use Cases

Restaurant Operations

  • Provider Selection: Choose best performing provider for bookings
  • Troubleshooting: Identify and resolve provider issues
  • Performance Monitoring: Track provider reliability and speed
  • Capacity Planning: Understand which providers handle peak loads

Customer Experience

  • Fallback Strategy: Automatic provider switching on failures
  • Optimal Routing: Route bookings to fastest/most reliable provider
  • Transparency: Show customers which booking method will be used

Business Intelligence

  • Provider ROI: Analyze which providers generate most bookings
  • Cost Optimization: Compare provider costs vs performance
  • Service Level Agreements: Monitor provider SLA compliance

๐Ÿ“Š Status Indicators

Health Status

  • ๐ŸŸข Healthy: Provider is operational and responding normally
  • ๐ŸŸก Degraded: Provider experiencing issues but still functional
  • ๐Ÿ”ด Unhealthy: Provider is down or not responding
  • โšซ Disabled: Provider is intentionally disabled for this restaurant

Performance Metrics

  • Response Time: < 2s = Excellent, 2-5s = Good, > 5s = Poor
  • Success Rate: > 95% = Excellent, 85-95% = Good, < 85% = Poor
  • Error Rate: < 1% = Excellent, 1-5% = Acceptable, > 5% = Concerning

๐Ÿ”„ Real-Time Monitoring

This endpoint performs live health checks when called, ensuring you get the most current status information. For high-frequency monitoring, consider the summary endpoint which uses cached data.

  • Provider Configuration: PUT /providers/{restaurantId}/config
  • Priority Management: GET/PUT /providers/{restaurantId}/priority
  • Health Monitoring: GET /providers/health (global status)
  • Performance Analytics: GET /management/{restaurantId}/analytics

Path parameters

restaurantIdstringRequired>=1 character
Unique identifier for the restaurant

Response

Provider status retrieved successfully
successbooleanOptional
restaurantIdstringOptional
providerslist of objectsOptional
healthybooleanOptional
Overall system health
totalProvidersdoubleOptional
healthySummaryobjectOptional
lastCheckeddatetimeOptional

Errors

404
Not Found Error