Method to retrieve cumulative statistics for requests & bookings per user country

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

URL Endpoint

GET /statistics/performance_per_country/{propertycode}

Terms

This method should be called only for user-initiated actions.

Scheduled ( automated ) calls on this method are only allowed if they happen a few times per day.

This method should NOT be used to feed 3rd party systems without our consent.

API usage is closely monitored and improper usage will result in a ban without further warning.

Warning

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


Method parameters

NAME TYPE RANGE / SET REQUIRED DEFAULT EXAMPLE NOTES
from date (ISO 8601) * YES &from=2017-02-21  
to date (ISO 8601) from + 12 months YES &to=2017-03-21  

Example JSON Response

{
	"method": "http://rest.reserve-online.net/statistics/performance_per_country/DEMO"
	"http_method": "GET",
	"http_code": 200,
	"error_code": "OK",
	"error_msg": "",
	"params": [
		{
			type: "URL"
			name: "from"
			value: "2017-02-21"
		},
		{
			type: "URL"
			name: "to"
			value: "2017-03-21"
		}
	],
	"data":{
		"stats":[
			{
				"country":ISO 3166-1-alpha-2,
				"country_name":STRING, // Country name
				"requests":INTEGER, // Total count of requests made by users from this country
				"room_nights":INTEGER, // Total count of requested nights by users from this country
				"avg_nights":FLOAT, // Average requested nights ( room_nights / requests )
				"avg_lead":FLOAT, // Average days between request date and check-in date
				"booked_room_nights":INTEGER // Total count of nights from all bookings by users from this country
			}
		]
	}
}