Oracle Hospitality Profile Statistics API
These APIs will allow you to retrieve statistical data for a specified profile.
Oracle Hospitality Profile Statistics API is one of 154 APIs that Oracle Hospitality publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include ProfileStatistics. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 3 operations across 3 paths, and defines 138 schemas. It is described by OpenAPI 3.2.0, at version 26.2.0.0.
Requests are made against a single base URL, /crm/v1.
3 operations
3 paths
138 schemas
3 GET
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 3
Across 3 paths, the API surfaces 3 operations — 3 GET. Each is listed below with its method, path, parameters, and response codes.
ProfileStatistics 3
These APIs will allow you to retrieve statistical data for a specified profile.
GET
/profileMembershipStatistics
Get Membership statistics
GET
/profileStatistics
Get Profile Statistics
GET
/services/profileStats/status
Operation to check the status of ProfileStats service
Schemas 138
The contract defines 138 schemas that model the data the API accepts and returns. The most detailed are stayDetailType (70 properties), stayInfoType (36 properties), resGuestInfoType (30 properties), resPaymentCardType (19 properties). Each schema is shown below with its type and property counts.
profileStatistics
object
Response object for fetching profile stay/reservation/revenue statistics. This object contains collection of summary or detail,Success,Warnings and Errors rela…
9 properties
reservationQueueInformationType
object
Information regarding the Date, Duration and Priority of the reservation on Queue for Check in.
6 properties
guestHousekeepingServiceRequestType
string
Possible values for the Guest Service Status.
resAccompanyGuestInfoType
object
5 properties
stayInfoType
object
Details on the Room Stay including Guest Counts, Time Span of this Room Stay, pointers to Res Guests, guest Memberships, Comments and Special Requests pertaini…
36 properties
resSharedGuestInfoType
object
Contains information regarding the share reservation.
4 properties
cardTypeType
string
This is required for Credit Card Payment Methods. This indicates the type of Credit Card associated with this payment method.
statisticsRevenueTypeType
object
Contains Revenue information
2 properties
numericUDFType
object
Used to hold user defined field of Numeric Type. It is highly recommended to use UDFN01, UDFN02,...UDFN40 (Total 40) as Numeric UDF names(commonly used on Rese…
3 properties
stayDetailSummaryType
object
Contains stay related information such as reservation nights,room nights,arrival rooms,cancel rooms,etc.
8 properties
stayReservationType
string
Enumeration for stay types.
reservationFolioWindowsType
array
Collection of reservation folio windows.
namePrefixType
string
Salutation of honorific (e.g. Mr., Mrs., Ms., Miss, Dr.). Currently this attribute is not used for PUT and POST operations.
membershipTierPointsType
object
Collection of the tier points.
5 properties
membershipTransactionInfoType
object
Specific details regarding the transaction.
14 properties
resAccessRestrictionType
string
Indicates any Updates/Changes on the reservation as well as Reservation Cancellation are not allowed.
pointsType
object
The Redeem Points contains the number of points required to book a room type.
2 properties
reservationIdList
array
Unique Id that references an object uniquely in the system.
communicationStatusType
string
Enum to denote the Status of Readiness messages sent to Guest Devices.
resCashieringType
object
Cashiering Information for the reservation.
14 properties
revenueTransactionCodeListType
object
List of revenue by transaction codes.
1 property
profileHotelStatisticsbyYearSummaryType
object
Contains stay statistics summary information by year
5 properties
resPaymentCardType
object
Information on a credit card for the customer.
19 properties
reservationDepositType
object
Reservation Deposit Type.
7 properties
resHousekeepingType
object
Holds housekeeping turndown service information for the room.
7 properties
reservationPaymentMethodType
object
7 properties
characterUDFsType
array
Used to hold collection of user defined fields of Character/String Type.
indicatorsType
array
Collection of lamp indicators.
timeSpanType
object
Allows for a choice in description of the amount of time spanned by this type. EndDate specifies a specific date, while Duration provides a measure of time to…
3 properties
queueTextInfoType
object
Information regarding the message sent to guest.
2 properties
profileMembershipStatistics
object
Response of the WS operation FetchProfileMembershipPoints. It contains the summary statistics and/or the details of each of the membership transactions and its…
9 properties
indicatorType
object
Lamp indicator Type.
2 properties
stayMembershipSummaryType
object
Rendering membership type and membership card number associated to a stay.
2 properties
addressInfoType
object
Provides address information.
3 properties
warningsType
array
Used in conjunction with the Success element to define a business error.
folioTextsType
array
This stores the description for the type of tax calculation especially with tax exemption, etc.
revenueStatisticsSummaryListType
array
List of the detailed and yearly summarized information about the profile revenue.
aRAccountShortInfoType
object
Accounts Receivabales Account details type charged for batched posting.
4 properties
cardNumberTypeType
string
Simple type for indicating if credit card number is tokenized.
uniqueID_Type
object
An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number,…
3 properties
telephoneType
object
Information on a telephone number for the customer.
12 properties
currencyAmountType
object
A monetary value expressed with a currency code.
2 properties
telephoneInfoType
object
Information on a telephone number for the customer.
3 properties
reservationTurndownInfoType
object
Turndown information for a reservation
2 properties
stayMembershipSummaryListType
object
Details about stay membership.
1 property
housekeepingRoomStatusType
string
Simple type for room status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Clean, Dirty, Pickup, Inspected, OutOf…
resProfileTypeType
string
waitlistResType
object
Information regarding why reservation is being /has been waitlisted.
6 properties
instanceLink
object
Metadata describing link description objects that MAY appear in the JSON instance representation.
7 properties
statisticsReportType
string
Indicate to get revenue of Stay Records.
membershipStatisticsSummaryType
object
Totals of the each of the points.
5 properties
hotelInterfaceType
object
8 properties
cardProcessingType
string
resCommunicationType
object
Communication details for a reservation.
2 properties
promotionType
object
Type to specify a rate promotion. Usually attached to a reservation to indicate a specific promotion is applied to the reservation.
3 properties
revenueBucketListType
object
Details about revenue summary.
1 property
revenueStatisticsDetailType
object
The different statistics from the revenue of a profile.
9 properties
stayStatisticsDetailListType
array
Collection of stay statistics detail information
nameTypeType
string
membershipInfoType
object
The Membership object identifies the frequent customer reward program.
8 properties
profileStatisticsType
object
Contains summary/detail/Revenue statistics information for Profile.
6 properties
housekeepingTaskCodeType
object
Information related to a Task Code. Task Codes are used to generate task sheets in Rooms Management.
7 properties
payeeInfoType
object
Payee information.
7 properties
resAccompanyGuestListType
array
Collection of accompany guests
blockIdList
array
Unique Id that references an object uniquely in the system.
basicEmailType
string
Email address
resSharedGuestListType
array
Collection of shared guest reservations.
revenueBucketType
object
The different revenue buckets of a profile.
3 properties
resMobileNotificationsType
object
Contains the status of Room Ready and Key Ready messages.
5 properties
facilityTaskType
object
Information regarding facility task on a reservation.
3 properties
sourceOfSaleType
object
Point of Sale of reservation. Identifies the entity/channel who made the reservation.
2 properties
membershipTransactionSummaryType
object
Details regarding a transaction of a profile membership.
11 properties
stayStatisticsDetailType
object
Contains stay statistics detail information
4 properties
surnameType
string
Family name, last name.
guestLastStayInfoType
object
Contains last stay related details of the guest.
4 properties
revenueTransactionCode
object
Revenue by transaction codes.
8 properties
emailInfoType
object
Information on an email for the customer.
3 properties
warningType
object
Used when a message has been successfully processed to report any warnings or business errors that occurred.
10 properties
exceptionDetailType
object
Complex type that contains error details for a REST call.
9 properties
2 required
resPeriodicFolioType
object
Information regarding periodic folios set on the reservation.
3 properties
facilityCodesType
array
List of the facility codes.
resAttachedProfileListType
array
numericUDFsType
array
Used to hold collection of user defined fields of Numeric Type.
searchMatchType
object
Search match indicating attribute and the matching value.
2 properties
resGuestExternalInfoType
object
Specifies Company or Travel Agent profile using IATA or Corp. No.
2 properties
resGuaranteeType
object
Validations type record returned after Validations are done.
3 properties
dateUDFsType
array
Used to hold collection of user defined fields of Date Type.
resCompAccountingType
object
Information regarding comp accounting on the reservation.
3 properties
phoneNumberType
string
Phone number
hotelInterfaceStatusType
string
Status of the Hotel Interface either STOPPED or RUNNING.
givenNameType
string
Given name, first name or names
stayStatisticsRevenueType
object
Contains different list of stay statistics revenue information
8 properties
dateUDFType
object
Used to hold user defined field of Date Type.
3 properties
advanceCheckInType
object
Information relating to Reservation's Advance Checked In state and Expected Time of Return
3 properties
resRevenueBalanceType
object
Revenue and Balance Amount summary for the reservation.
9 properties
facilityCodeType
object
Facility Housekeeping Code, its description and quantity.
3 properties
anonymizationType
object
Provides information about guest's anonymization status.
2 properties
resAttachedProfileType
object
3 properties
emailType
object
Information on an email for the customer.
11 properties
operaVersionNumberType
string
Current Opera Version Number
addressType
object
Provides address information.
18 properties
taxTypeType
object
Provides information about the Tax Type.
8 properties
bedTaxReportingType
object
This stores the information for Bed Tax Reporting. Mainly used in Maldives.
5 properties
reservationAllowedActionsType
array
Allowed action.
vIPType
object
The supplier's ranking of the customer.
2 properties
searchMatchesType
array
List of Generic Name-Value-Pair Parameters used for super search matches.
profileStatisticsbyYearSummaryType
object
Contains stay statistics summary information by year
4 properties
countryNameType
object
Code for a country or a nationality.
2 properties
errorInstance
object
Complex type that contains error instance details for a REST call.
7 properties
2 required
userDefinedFieldsType
object
A common type used to hold user defined fields(UDFs). This type should be used to handle UDFs on RReservation, Profiles, etc.
3 properties
resExpectedTimesType
object
Holds the Arrival and Departure Time Information
2 properties
pMS_ResStatusType
string
This reservation is in checked in status and the business date is past departure date. This could occur when ORS and PMS are in same environment.
resPreConfiguredRoutingInstrType
object
Instruction to attach Pre-Configured Routing Instructions to a Reservation.
3 properties
revenueStatisticsDetailListType
array
The collection of profile revenue statistics.
interfaceRightsStatusType
object
4 properties
aRAccountStatusType
object
Type for the Account Status. Status can be restricted and a message/description added to the Account.
3 properties
stayDetailType
object
The Reservation class contains the current reservation being created or altered.
70 properties
resGuestInfoType
object
Specifies Company or Travel Agent profile using IATA or Corp. No.
30 properties
billingPrivilegesType
object
This stores the information for Bed Tax Reporting. Mainly used in Maldives.
13 properties
reservationFolioWindowType
object
Folio window view which holds the set of folios for a reservation.
4 properties
reservationBlockType
object
Key information about the block for a reservation.
3 properties
reservationTaxTypeInfo
object
Provides information about the Tax Type.
9 properties
profileId
object
An identifier used to uniquely reference an object in a system (e.g. an airline reservation reference, customer profile reference, booking confirmation number,…
4 properties
anonymizationStatusType
string
Guest has been anonymized.
characterUDFType
object
Used to hold user defined field of Character/String Type.
3 properties
membershipStatisticsType
object
List of membership transactions and the summary of the different total points statistics.
5 properties
profileIdList
array
Unique Id that references an object uniquely in the system.
statisticsSummaryListType
object
Collection of Profile statistics summary information
2 properties
revenueStatisticsSummaryType
object
Summary of the revenue for a year
4 properties
reservationInterfaceStatusType
object
Hotel Interface Type for a reservation and status of the various services
3 properties
operaVersion
object
Response for Ping operation.
3 properties
reservationAllowedActionType
string
Flag indicating whether the Enrollment is in progress or not for the Profile associated with this Reservation.
links
array
addressSearchType
object
Address Details such as city, state, country, postal code etc.
6 properties
authorizationRuleType
object
Configured rule for computing the amount to authorize.
3 properties
commissionPayoutToType
string
hotelInterfaceTypeType
string
XML Posting Interface
turndownStatusType
string
Simple type for turndown status instructions to be used in requests for fetching housekeeping rooms. Valid status values are Required, Not Required and Complet…
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Oracle Hospitality 12
Other APIs Oracle Hospitality publishes across the network.
OPERA Cloud RnA Activities GraphQL API
OPERA Cloud RnA ARAccountsReceivable GraphQL API
OPERA Cloud RnA ARAgingReport GraphQL API
OPERA Cloud RnA ARLedger GraphQL API
OPERA Cloud RnA BookingReservationExtended GraphQL API
OPERA Cloud RnA BookingsBlockProductionChanges GraphQL API
OPERA Cloud RnA BookingsBlockStatusChanges GraphQL API
OPERA Cloud RnA BookingsBlock GraphQL API
OPERA Cloud RnA BookingsReservation GraphQL API
OPERA Cloud RnA CateringEventForecast GraphQL API
OPERA Cloud RnA CateringEventPostings GraphQL API
OPERA Cloud RnA CateringEventStatusChanges GraphQL API
#ProfileStatistics
Where this information came from
This is an independent, third-party profile of Oracle Hospitality Profile Statistics API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.