1. Rooms
WinCloud API
  • Getting Started
    • Introduction
    • Quick Start
    • Authentication
    • General
    • Changelog
    • Privacy Policy
    • Terms of Service
    • Support
  • APIs
    • Guests
      • Search Guests
      • Create Guest
      • Get Guest Details
      • Update Guest
      • Get Guest Reservations
      • Get Guest Reference Data
    • Inventory
      • Get Room Inventory
      • Get Room Inventory Details
      • Update Room Inventory
    • Properties
      • Get Customer Properties
      • Get Property Configuration
    • Rates
      • Get Rate Adjustment Templates
      • Get Master Rates
      • Post Master Rates
      • Post Individual Rates
    • Reference Data
      • Get Countries
      • Get Payment Gateways
      • Get Payment Methods
      • Get Currencies
    • Reservations v1
      • Get Reservations
      • Get Cancelled Reservations
      • Get No-Show Reservations
      • Get Reservation Statuses
      • Update Special Instructions
    • Reservations v2
      • List Reservations
      • Get Reservation
    • Rooms
      • Get Rooms
        GET
      • Get Room Types
        GET
      • Get Rooms Extra Charges
        GET
      • Get Rooms Feature Types
        GET
      • Get Rooms Tariffs
        GET
      • Get Room and Revenue Performance
        GET
    • Travel Agents
      • Get Active Travel Agents
    • POS
      • Get Outlet Menu
    • Booking Analytics
      • Get Arrival Summary
      • Get Booking Summary
    • Schemas
      • CodeNameDto
      • ArrivalFiguresDto
      • CompanyDto
      • ArrivalSummaryDto
      • CompanyDtoPaginatedResponse
      • ArrivalSummaryDtoApiResponse
      • CompanyDtoPaginatedResponseApiResponse
      • BookingSummaryDto
      • CountryDto
      • ConfigurationOutletDto
      • BookingSummaryDtoApiResponse
      • CountryDtoApiResponse
      • ConfigurationRoomTypeDto
      • CountryRefDto
      • CurrencyDto
      • CurrencyDtoPaginatedResponse
      • CurrencyDtoPaginatedResponseApiResponse
      • ExtraChargeDto
      • ExtraChargeDtoApiResponse
      • FeatureTypeDto
      • CurrencyRefDto
      • FeatureTypeDtoPaginatedResponse
      • FeatureTypeDtoPaginatedResponseApiResponse
      • GuestCreatedDto
      • GuestAddressDto
      • GuestCreatedDtoApiResponse
      • GuestLookupsDto
      • GuestLookupsDtoApiResponse
      • DepartureFiguresDto
      • GuestPhoneDto
      • GuestPreferencesDto
      • GuestProfileDtoApiResponse
      • GuestProfileDto
      • GuestReservationDtoPaginatedResponse
      • GuestReservationDtoPaginatedResponseApiResponse
      • GuestStaySummaryDto
      • GuestReservationDto
      • GuestProfileRequestDto
      • GuestSummaryItemDto
      • GuestSummaryItemDtoPaginatedResponse
      • GuestPassportDto
      • GuestSummaryItemDtoPaginatedResponseApiResponse
      • InventoryRoomTypeDto
      • InventorySnapshotDto
      • InventorySnapshotDtoPaginatedResponse
      • InventorySnapshotDtoPaginatedResponseApiResponse
      • LanguageRefDto
      • MasterRateBlockDto
      • MasterRateTypeDto
      • MasterRateTypeDtoPaginatedResponse
      • MasterRateTypeDtoPaginatedResponseApiResponse
      • LinkedGuestDto
      • MealPlanDto
      • ObjectApiResponse
      • PayMethodDto
      • PayMethodDtoPaginatedResponse
      • OtaReferenceDto
      • PayMethodDtoPaginatedResponseApiResponse
      • PaymentGatewayDto
      • PaymentGatewayDtoPaginatedResponse
      • PaymentGatewayDtoPaginatedResponseApiResponse
      • ProblemDetails
      • PosMenuItemDto
      • RateAdjustmentTemplateDto
      • PosMenuItemDtoPaginatedResponse
      • RateAdjustmentTemplateDtoPaginatedResponse
      • PosMenuItemDtoPaginatedResponseApiResponse
      • RateAdjustmentTemplateDtoPaginatedResponseApiResponse
      • RatePlanRefDto
      • RecentReservationsDto
      • ReservationBillingDto
      • ReservationCancellationDto
      • PropertyConfigurationDto
      • ReservationEventDtoPaginatedResponse
      • PropertyConfigurationDtoApiResponse
      • ReservationEventDtoPaginatedResponseApiResponse
      • ReservationSourceDto
      • ReservationStatusDto
      • ReservationDtoApiResponse
      • ReservationDtoListApiResponse
      • ReservationStatusDtoListApiResponse
      • ReservationDtoPaginatedResponse
      • ReservationStayStatusDto
      • ReservationDtoPaginatedResponseApiResponse
      • RoomAssignmentItemDto
      • ReservationBookingDto
      • RoomCheckInDto
      • RoomCheckOutDto
      • RoomDto
      • RoomDtoPaginatedResponse
      • RoomDtoPaginatedResponseApiResponse
      • ReservationEventDto
      • RoomInventoryUpdateRequestDto
      • RoomInventoryUpdateResponseDto
      • RoomInventoryUpdateResponseDtoApiResponse
      • RoomRateDto
      • ReservationDto
      • RoomRateDtoPaginatedResponse
      • RoomRateDtoPaginatedResponseApiResponse
      • ReservationRoomDto
      • RoomRateFailureDto
      • RoomRateItemDto
      • RoomRateUpdateRequestDto
      • RoomRateUpdateResponseDto
      • RoomRateUpdateResponseDtoApiResponse
      • ReservationGuestDto
      • RoomTypeDto
      • ReservationOccupancyDto
      • RoomTypeDtoPaginatedResponse
      • RoomTypeDtoPaginatedResponseApiResponse
      • RoomTypeRefDto
      • StaySpendDto
      • TemplateDateRangeDto
      • TitleRefDto
      • TravelAgentDto
      • RoomPerformanceComparisonDto
      • TravelAgentDtoPaginatedResponse
      • RoomPerformanceMetricsDto
      • TravelAgentDtoPaginatedResponseApiResponse
      • RoomPerformancePeriodDto
      • UpdateMasterRatesRequestDto
      • RoomPerformanceResponseDto
      • UpdateMasterRatesResultDto
      • RoomPerformanceResponseDtoApiResponse
      • UpdateMasterRatesResultDtoApiResponse
      • UpdateReservationRequestDto
      • UpdateReservationResponseDtoApiResponse
      • RoomTypePerformanceDto
      • UpdateReservationResponseDto
      • SpecialRequestsDto
  • MCP
    • Overview
    • Connect Your AI Assistant
  • Webhooks
    • Set Up and Edit Webhooks
    • Verify Webhook Signatures
    • List of Webhook Events
  1. Rooms

Get Room and Revenue Performance

GET
https://uat-api.wincloudone.com/stdinterface/api/v1/rooms/performance
Rooms
Last modified:2026-11-04 11:13:56

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

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Query Params

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://uat-api.wincloudone.com/stdinterface/api/v1/rooms/performance?companyId=&ReportDate=&FromDate=&ToDate=&RoomTypeId=&ComparisonPeriod=' \
--header 'Authorization: Bearer <token>'

Responses

🟢200
application/json
Returns performance metrics and source limitations.
Body

Example
{
    "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"
}
🟠400
🟠401
🟠403
🟠404
🔴500
Modified at 2026-11-04 11:13:56
Previous
Get Rooms Tariffs
Next
Get Active Travel Agents
Built with