GET hotels/{hotelId}/statistics/operation?key={key}&date={date}
Gets operational forecast analysis for the hotel specified on a specific date. Valid for future dates only.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
hotelId |
Hotel-Id => checked against the calling applications permissions |
string |
Required |
key |
API - Key identifying the caller |
string |
Required |
date |
Date for which to retrieve Statistics, Format YYYY-MM-DD |
date |
Required |
Body Parameters
None.
Response Information
Resource Description
One OperationalStatistic
OperationalStatisticName | Description | Type | Additional information |
---|---|---|---|
Date |
Date for the set of statistics |
date |
None. |
Groups |
Number of rooms blocked for groups on the selected date |
integer |
None. |
GroupRoomsNotPickedUp |
Number of rooms blocked for groups but not picked up |
integer |
None. |
RoomRevenue |
room - revenue for the selected date |
decimal number |
None. |
AverageDailyRate |
Average daily Rate for the selected date |
decimal number |
None. |
Occupancy |
Number of occupied rooms on the selected date |
integer |
None. |
Response Formats
application/json, text/json
Sample:
{ "Date": "2024-11-21T17:59:29.3803158-08:00", "Groups": 2, "GroupRoomsNotPickedUp": 3, "RoomRevenue": 4.0, "AverageDailyRate": 5.0, "Occupancy": 6 }
application/xml, text/xml
Sample:
<OperationalStatistic xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RoomKeyAPI.Models"> <AverageDailyRate>5</AverageDailyRate> <Date>2024-11-21T17:59:29.3803158-08:00</Date> <GroupRoomsNotPickedUp>3</GroupRoomsNotPickedUp> <Groups>2</Groups> <Occupancy>6</Occupancy> <RoomRevenue>4</RoomRevenue> </OperationalStatistic>