Performance Summary - API

Method to retrieve confirmed bookings, cancelled bookings & revenue of a property, within a specified period of time.

Table of Contents
  1. URL Endpoint
  2. Method Parameters
  3. JSON Response Schema
  4. JSON Response Example

URL Endpoint

GET /statistics/performance_summary/{propertycode}

Warning

This method is only accessible using a Hotelier or Operator API account.


Method parameters

NAME TYPE RANGE / SET REQUIRED DEFAULT EXAMPLE NOTES
book_from date (ISO 8601) * YES – &book_from=2025-11-03  
book_to date (ISO 8601) from + 12 months YES – &book_to=2025-11-04  
source_id integer * NO –    
daily_breakdown boolean   NO false &daily_breakdown=1 Appends daily breakdown of bookings for the specified date range

JSON Response Schema

{
	"method": "https://rest.reserve-online.net/statistics/performance_summary/DEMO"
	"http_method": "GET",
	"http_code": 200,
	"error_code": "OK",
	"error_msg": "",
	"params": [
		{
			"type": "URL",
			"name": "book_from",
			"value": "2025-11-03"
		},
		{
			"type": "URL",
			"name": "book_to",
			"value": "2025-11-04"
		}
	],
	"data":{
		"summary": {
			"confirmed_bookings":INTEGER, // Total count of confirmed bookings where the booking date falls within the specified dates
			"revenue":BIGDECIMAL, // Total revenue from confirmed bookings where the booking date falls within the specified dates
			"cancelled":INTEGER, // Total count of cancelled bookings where the booking date falls within the specified dates
			"cancelled_revenue":BIGDECIMAL, // Total revenue from cancelled bookings where the booking date falls within the specified dates
		},
		"daily_breakdown": [
			{
				"date": ISO 8601, // Date
				"confirmed_bookings": INTEGER, // Count of confirmed bookings for that date
				"revenue": BIGDECIMAL, // Revenue for that date
				"cancelled": INTEGER // Count of cancelled bookings for that date
				"cancelled_revenue": BIGDECIMAL, // Revenue for cancelled bookings for that date
			}
		]
	}
}

JSON Response Example