Get reservations analytics
GET/api/v2/reservations/analytics
Get reservations analytics
Request
Query Parameters
business_id string[]
start_date date-time
end_date date-time
Responses
- 200
- 400
- 401
- 403
- 404
Returns analytics for reservations made across all the users reservations
- application/json
- Schema
- Example (from schema)
Schema
avg_party_size floatrequired
Average party size of the reservations
avg_lead_time float
Average lead time in days
counts
object
required
booked number
canceled number
placed number
rejected number
total number
guests
object
required
repeated_percent floatrequired
Percent of guests that have made more than one reservation
unique numberrequired
Count of unique guests
repeated numberrequired
Count of guests that have made more than one reservation
conversion_rate
object
required
confirmed floatrequired
Percent of confirmed reservations
cancelled floatrequired
Percent of cancelled reservations
pending floatrequired
Percent of pending reservations
popular_time_slot number
Most popular time slot in seconds in the UTC timezone. It can be converted to a time string, when doing, so you should take the businesses timezone offset into account.
{
"avg_party_size": 4.14285714285,
"avg_lead_time": 1.92063492063,
"counts": {
"booked": 0,
"canceled": 0,
"placed": 0,
"rejected": 0,
"total": 0
},
"guests": {
"repeated_percent": 22.2222222222,
"unique": 27,
"repeated": 6
},
"conversion_rate": {
"confirmed": 75.9036144578,
"cancelled": 22.891566265,
"pending": 1.2048192771
},
"popular_time_slot": 45000
}
Loading...