Sign in

v1

latestOpenAPI 3.0.2EULA2026-07-143221521.2 MB
Bookings

Get information about booking busy times

Returns booking occupancy data for a specified date and time period. The action method provides data on the busiest times of bookings in a period. The period can change depending on the parameters set up. The chart contains time intervals on the X axis and Percentage information about reserved time slots (70% of slots for the time is reserved) on the Y axis. Filter by booking ticket or ticket property to narrow the scope of the data.

post/bookings/actions/average-booking-busy-times

Headers

Accept-Languagestring

The unique ID of the language code by ISO 639-1.

Request body

booking_datestring required

The date when you want to check how busy the bookings are

time_period'day' | 'week' | 'month' | 'year' required

The period that the algorithm uses to calculate past busy times and return your data in that period. If you set the value as DAY, the algorithm will return the data for one day in an hour range.

booking_ticket_idstring

The unique ID of the booking ticket. If not set, the data will be returned for all available tickets.

booking_property_idstring

Booking ticket property ID from resource booking-ticket-properties. The parameter determines property, which is used to filter resources by their properties. The parameter must be used in combination with property_value otherwise is ignored in the request.

booking_property_valuestring

Booking ticket property record value from booking-ticket-properties in case of datatype with multiple values. Parameter filters resources depends of store property record value. The parameter must be used in combination with property_id otherwise is ignored in the request.

Example request

{
  "booking_date": "2023-01-15",
  "time_period": "week",
  "booking_ticket_id": "13b8984a16913b8984a169cc490a",
  "booking_property_id": "store",
  "booking_property_value": "89ac83ca207a20c62c79bf"
}

Response

OK

Example response

{
  "data": {
    "time_unit": "hour",
    "chart_data": [
      {
        "x_axis_value": "7",
        "y_axis_value": "32"
      }
    ]
  }
}