Get reservation analytics

GET 
/api/v1/businesses/:id/dashboard/reservation_analytics

Return reservation analytics for dashboard

Request

Path Parameters

id int32required

Query Parameters

filter[start_date] date
filter[end_date] date

Responses

200

Return reservation analytics for dashboard

application/vnd.api+json

Schema

Schema

data

object

required

id stringrequired

type stringrequired

Possible values: [reservation_analytics]

attributes

object

required

average_lead_time number

average_party_size number

conversion_rate

object

cancelled number

confirmed number

pending number

popular_time_slot string

repeated_guests number

Example (from schema)

{
  "data": {
    "id": "string",
    "type": "reservation_analytics",
    "attributes": {
      "average_lead_time": 0,
      "average_party_size": 0,
      "conversion_rate": {
        "cancelled": 0,
        "confirmed": 0,
        "pending": 0
      },
      "popular_time_slot": "string",
      "repeated_guests": 0
    }
  }
}

Example

{
  "data": {
    "id": "2023-10-10 10:10:10 UTC",
    "type": "reservation_analytics",
    "attributes": {
      "average_lead_time": 19,
      "average_party_size": 2,
      "conversion_rate": {
        "cancelled": 40,
        "confirmed": 50,
        "pending": 10
      },
      "popular_time_slot": "11:00 AM UTC",
      "repeated_guests": 25
    }
  }
}

Loading...