GET
/
api
/
v1
/
reports
/
occupancy
Occupancy report
curl --request GET \
  --url http://127.0.0.1:8080/api/v1/reports/occupancy
{
  "total_rooms": 123,
  "occupied_rooms": 123,
  "vacant_rooms": 123,
  "maintenance_rooms": 123,
  "hidden_rooms": 123,
  "occupancy_rate": 123,
  "rows": [
    {
      "property_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "property_name": "<string>",
      "total_rooms": 123,
      "occupied_rooms": 123,
      "vacant_rooms": 123,
      "maintenance_rooms": 123,
      "hidden_rooms": 123,
      "occupancy_rate": 123
    }
  ],
  "property_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Query Parameters

property_id
string<uuid>

Optional property filter

Response

200 - application/json

Occupancy report

total_rooms
integer<int64>
required
occupied_rooms
integer<int64>
required
vacant_rooms
integer<int64>
required
maintenance_rooms
integer<int64>
required
hidden_rooms
integer<int64>
required
occupancy_rate
number<double>
required
rows
object[]
required
property_id
string<uuid> | null