Returns numeric room revenue, room tax, occupancy, ADR and RevPAR; selected-period daily trends;
daily, month-to-date and financial-year-to-date totals; active-room-type analysis; and prior-period changes.
Without a date pair, the selected period is the report date. Ranges include at most 366 days.
Uses the documented simplified report formulas, not every legacy UI option or budget variance.
Requires the rates:read scope. Source update time is unknown; LastUpdatedDateTime and GeneratedAt are the response time.
Sample request:
GET /api/v1/rooms/performance?companyId=WS&reportDate=2026-11-02&fromDate=2026-10-27&toDate=2026-11-02&comparisonPeriod=previousPeriod
Headers:
Authorization: Bearer
Authorization: Bearer ********************curl --location 'https://uat-api.wincloudone.com/stdinterface/api/v1/rooms/performance?companyId=&ReportDate=&FromDate=&ToDate=&RoomTypeId=&ComparisonPeriod=' \
--header 'Authorization: Bearer <token>'{
"success": true,
"message": "string",
"errorCode": "string",
"statusCode": 0,
"data": {
"propertyCode": "string",
"companyId": "string",
"reportDate": "2019-08-24",
"selectedPeriod": {
"period": "string",
"fromDate": "2019-08-24",
"toDate": "2019-08-24",
"metrics": {
"roomRevenue": 0,
"taxRevenue": 0,
"totalRevenue": 0,
"roomNightsSold": 0,
"availableRoomNights": 0,
"occupancyPercentage": 0,
"adr": 0,
"adrWithComplimentary": 0,
"revPar": 0,
"occupiedRooms": 0,
"guestCount": 0,
"dayUseRooms": 0,
"dayUseRevenue": 0,
"singleOccupancyRevenue": 0,
"multipleOccupancyRevenue": 0
}
},
"periods": [
{
"period": "string",
"fromDate": "2019-08-24",
"toDate": "2019-08-24",
"metrics": {
"roomRevenue": 0,
"taxRevenue": 0,
"totalRevenue": 0,
"roomNightsSold": 0,
"availableRoomNights": 0,
"occupancyPercentage": 0,
"adr": 0,
"adrWithComplimentary": 0,
"revPar": 0,
"occupiedRooms": 0,
"guestCount": 0,
"dayUseRooms": 0,
"dayUseRevenue": 0,
"singleOccupancyRevenue": 0,
"multipleOccupancyRevenue": 0
}
}
],
"trend": [
{
"period": "string",
"fromDate": "2019-08-24",
"toDate": "2019-08-24",
"metrics": {
"roomRevenue": 0,
"taxRevenue": 0,
"totalRevenue": 0,
"roomNightsSold": 0,
"availableRoomNights": 0,
"occupancyPercentage": 0,
"adr": 0,
"adrWithComplimentary": 0,
"revPar": 0,
"occupiedRooms": 0,
"guestCount": 0,
"dayUseRooms": 0,
"dayUseRevenue": 0,
"singleOccupancyRevenue": 0,
"multipleOccupancyRevenue": 0
}
}
],
"roomTypes": [
{
"roomTypeId": "string",
"roomTypeName": "string",
"metrics": {
"roomRevenue": 0,
"taxRevenue": 0,
"totalRevenue": 0,
"roomNightsSold": 0,
"availableRoomNights": 0,
"occupancyPercentage": 0,
"adr": 0,
"adrWithComplimentary": 0,
"revPar": 0,
"occupiedRooms": 0,
"guestCount": 0,
"dayUseRooms": 0,
"dayUseRevenue": 0,
"singleOccupancyRevenue": 0,
"multipleOccupancyRevenue": 0
},
"detailRoomRevenue": 0,
"detailAdr": 0,
"detailRevPar": 0
}
],
"comparison": {
"comparisonPeriod": "string",
"baseline": {
"period": "string",
"fromDate": "2019-08-24",
"toDate": "2019-08-24",
"metrics": {
"roomRevenue": 0,
"taxRevenue": 0,
"totalRevenue": 0,
"roomNightsSold": 0,
"availableRoomNights": 0,
"occupancyPercentage": 0,
"adr": 0,
"adrWithComplimentary": 0,
"revPar": 0,
"occupiedRooms": 0,
"guestCount": 0,
"dayUseRooms": 0,
"dayUseRevenue": 0,
"singleOccupancyRevenue": 0,
"multipleOccupancyRevenue": 0
}
},
"revenueVariance": 0,
"revenuePercentageChange": 0,
"adrVariance": 0,
"adrPercentageChange": 0,
"revParVariance": 0,
"revParPercentageChange": 0
},
"lastUpdatedDateTime": "2019-08-24T14:15:22.123Z",
"generatedAt": "2019-08-24T14:15:22.123Z",
"limitations": [
"string"
]
},
"timestamp": "2019-08-24T14:15:22.123Z",
"correlationId": "string"
}