ETERA API Documentation

const url = 'https://api.etera.dev/restaurant/booking/management/rest_abc123/analytics?period=month&startDate=2024-01-01&endDate=2024-01-31';
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,
  "restaurantId": "rest_abc123",
  "period": "month",
  "analytics": {
    "totalBookings": 245,
    "confirmedBookings": 220,
    "cancelledBookings": 25,
    "averagePartySize": 3.2,
    "popularTimeSlots": [
      {
        "time": "19:00",
        "bookings": 45
      },
      {
        "time": "20:00",
        "bookings": 38
      },
      {
        "time": "18:30",
        "bookings": 32
      }
    ],
    "providerBreakdown": {
      "opentable": {
        "bookings": 180,
        "percentage": 73.5
      },
      "ai_calling": {
        "bookings": 45,
        "percentage": 18.4
      },
      "tablecheck": {
        "bookings": 20,
        "percentage": 8.1
      }
    },
    "revenueImpact": {
      "totalCover": 784,
      "estimatedRevenue": 15680,
      "averageSpendPerBooking": 64
    }
  }
}

Retrieve comprehensive booking analytics for restaurant management.

Analytics Include:

📊 Booking Statistics - Total, confirmed, cancelled bookings
👥 Customer Insights - Party size patterns, repeat customers
⏰ Time Analysis - Popular time slots, peak hours
🔌 Provider Performance - Success rates by booking method
💰 Revenue Impact - Estimated revenue, average spend
📈 Trends - Period-over-period comparisons

Time Periods:

Day - Last 24 hours
Week - Last 7 days
Month - Last 30 days (default)
Year - Last 365 days
Custom - Specify startDate and endDate

Path parameters

restaurantIdstringRequired

Restaurant identifier

Query parameters

periodenumOptional

Analytics time period

Allowed values:

startDatestringOptionalformat: "^\d{4}-\d{2}-\d{2}$"

Custom period start date

endDatestringOptionalformat: "^\d{4}-\d{2}-\d{2}$"

Custom period end date

Response

Analytics data retrieved successfully

successbooleanOptional

restaurantIdstringOptional

periodstringOptional

analyticsobjectOptional

Errors

404

Not Found Error