-
Notifications
You must be signed in to change notification settings - Fork 0
Property Reports
Request:
-
Url
apis/property/{propertyid}/reports/{reporttype}?checkindate={checkInDate}&checkoutdate={checkOutDate}&bookeddatestart={bookedDateStart}&bookeddateend={bookedDateEnd}&bookingtagid={bookingTagId}
-
propertyId
required
integer type -
reporttype
required
only support1
for now (we will add more reports as needed) -
bookingTagId
optional
integer type -
checkInDate
optional
string type, such as2019-09-12
-
checkOutDate
optional
string type, such as2019-09-12
-
bookedDateStart
optional
string type, such as2019-09-12
-
bookedDateEnd
optional
string type, such as2019-09-12
-
Method
GET
Response:
{
"PropertyId": 8849,
"CurrencySymbol": "£",
"AverageRating": "4.9/5",
"NoOfComplaints": 20,
"Income": 34340,
"QTYBookings": {
"AgencyBookings": 15,
"OwnerBookings": 3,
"BlockOuts": 2
},
"NoNightsBooked": {
"AgencyBookings": 100,
"OwnerBookings": 20,
"BlockOuts": 4
},
"BookingValuesCurrentYear": {
"January": 3000,
"February": 5000,
"March": 2000,
"April": 4000,
"May": 4000,
"June": 5000,
"July": 7000,
"August": 3000,
"September": 2340
},
"TypeOfBooking": {
"Family": 10,
"Adults Only": 5,
"Multi Generational": 2,
"Holiday": 1,
"Special Occasion": 10,
"Couples Retreat": 2,
"New Guests": 10,
"Repeat Guests": 10,
"With A Dog": 10,
"Without A Dog": 10,
"Booking Within 7 Days": 10,
"Booking Starts Within 8 - 30 Days": 10,
"Booking Starts Within 31 - 60 Days": 10,
"Booking Starts Within 61 - 90 Days": 10,
"Booking Starts Within 91 - 180 Days": 10,
"Booking Starts Within 181 - 365 Days": 10,
"Booking Starts after 366 Days": 10
}
}
Income - This is calculated based on the accommodation cost only and is the gross price paid by the guest
AgencyBookings - Bookings that were processed by your own Agency
OwnerBookings - Bookings that were processed by the owner of the property
Blockouts - Nights blocked for some other reason
BookingValuesCurrentYear - This shows the value of the bookings based on check in date per month
TypeOfBooking - This is based on the booking tags used within the booking, it simply counts how many bookings have the tag assigned to the booking
- Get Started
- Settings
- Contacts
- Properties
- Properties
- Property Detail
- Property Images
- Property Extras
- Property Reference Lookup
- Property Rates
- Push Property Rates
- Property Custom Rates
- Property Availabilities
- Property Day Availabilities
- Property Rooms
- Property Distances
- Property All
- Property Search
- Property Search Lite
- Property Search Lite v2
- Property Enquiries
- Property Welcome Pack
- Push Property
- Properties Last Updated
- Property Day Availability Check
- Property Reviews
- Property Blockouts
- Property Detail Events
- Property Search Events
- Property Management
- Enquries
- Bookings
- Reviews
- Payments
- Offers & Deals
- Reports
- Communications