GET hotels/{hotelId}/statistics/operation?key={key}&fromDate={fromDate}&toDate={toDate}

Gets daily operational forecast analysis for the hotel specified on a specific date range. The maximum date range is limited to 60 days. 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
fromDate	Start date of the date range for which to retrieve Statistics, Format YYYY-MM-DD	date	Required
toDate	end date of the date range for which to retrieve Statistics (inclusive), Format YYYY-MM-DD	date	Required

Body Parameters

None.

Response Information

Resource Description

array of OperationalStatistic

Collection of OperationalStatistic

Name	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:47:45.000046-08:00",
    "Groups": 2,
    "GroupRoomsNotPickedUp": 3,
    "RoomRevenue": 4.0,
    "AverageDailyRate": 5.0,
    "Occupancy": 6
  },
  {
    "Date": "2024-11-21T17:47:45.000046-08:00",
    "Groups": 2,
    "GroupRoomsNotPickedUp": 3,
    "RoomRevenue": 4.0,
    "AverageDailyRate": 5.0,
    "Occupancy": 6
  }
]

application/xml, text/xml

Sample:

<ArrayOfOperationalStatistic xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RoomKeyAPI.Models">
  <OperationalStatistic>
    <AverageDailyRate>5</AverageDailyRate>
    <Date>2024-11-21T17:47:45.000046-08:00</Date>
    <GroupRoomsNotPickedUp>3</GroupRoomsNotPickedUp>
    <Groups>2</Groups>
    <Occupancy>6</Occupancy>
    <RoomRevenue>4</RoomRevenue>
  </OperationalStatistic>
  <OperationalStatistic>
    <AverageDailyRate>5</AverageDailyRate>
    <Date>2024-11-21T17:47:45.000046-08:00</Date>
    <GroupRoomsNotPickedUp>3</GroupRoomsNotPickedUp>
    <Groups>2</Groups>
    <Occupancy>6</Occupancy>
    <RoomRevenue>4</RoomRevenue>
  </OperationalStatistic>
</ArrayOfOperationalStatistic>