GET hotels/{hotelId}/statistics/summary?key={key}&date={date}

Gets a operational statistics-summary for the hotel specified on a specific date

Request Information

URI Parameters

NameDescriptionTypeAdditional 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

OperationalHistorySummary
NameDescriptionTypeAdditional information
Date

Date for this statistic

date

None.

AverageDailyRate

Average Rate on the selected day

decimal number

None.

Occupancy

Rooms occupied on the selected day

integer

None.

RevenuePerAvailableRoom

Room Revenue divided by number of rooms available on the selected date

decimal number

None.

RoomTypeOccupancies

Occupancy broken down by room type

Collection of RoomTypeOccupancy

None.

Response Formats

application/json, text/json

Sample:
{
  "Date": "2022-10-05T23:39:04.1008829-07:00",
  "AverageDailyRate": 2.0,
  "Occupancy": 3,
  "RevenuePerAvailableRoom": 4.0,
  "RoomTypeOccupancies": []
}

application/xml, text/xml

Sample:
<OperationalHistorySummary xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RoomKeyAPI.Models">
  <AverageDailyRate>2</AverageDailyRate>
  <Date>2022-10-05T23:39:04.1008829-07:00</Date>
  <Occupancy>3</Occupancy>
  <RevenuePerAvailableRoom>4</RevenuePerAvailableRoom>
  <RoomTypeOccupancies />
</OperationalHistorySummary>