Get information about booking busy times

post

https://{project_url}/webservice/rest-api/{api_interface}/{version}/bookings/actions/average-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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

booking_date

string

required

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

time_period

string

enum

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.

Allowed:

booking_ticket_id

string

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

booking_property_id

string

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_value

string

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.

Headers

Accept-Language

string

Defaults to cs, en-gb;q=0.8

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

Responses

`error.error_data.invalid_params[]` array lists the parameters that caused the failure, each carrying a `reason` code. See the `BadRequestErrorBody` schema for the generic reason taxonomy. Operations with domain-specific business rules document additional reasons at the operation level.

429

Too many requests - more than the resource limit.

503

Temporary state when the service is temporarily unavailable, overloaded or there is a maintenance window.

Language

Credentials

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

401The client has invalid credentials or auth token.

403The client does not exist or the client tried to access an unauthorized property or resource.

404The request path does not match any API route, or the addressed resource does not exist.

405The request path matches a valid route, but the endpoint does not support the HTTP method used in the request.

500Server is not working as expected.