Skip to content

Saturation

Rates Saturation API returns accommodation occupancy data for the specified {Location}.

Request

Endpoint

GET /v4/{billing_plan}/account/{account_id}/locations/rates/saturation/overall/

Path Parameters

Name                       Description Type Examples
*{billing_plan} Billing plan to be applied to the call. string ondemand
*{account_id} Provided identifier of the account. string
/sample Filter data for POIs that are included in the sample (subset of POIs that statistically replicates the population of the corresponding location). string
/sample optional path parameter

Inserting optional path parameter /sample in the following position:

  • /v4/{billing_plan}/account/{account_id}/locations/sample/…

will filter data for POIs that are included in the sample (subset of POIs that statistically replicates the population of the corresponding location).

Header Parameters

Name                          Description Type Examples                         
*x-api-key Provided API key {x_api_key} that allows authentication. string
*Authorization Provided token {jwt_bearer} that allows authorization. string Bearer {jwt_bearer}

Query Parameters

Name                       Description Type Examples                 Default
*{Viewport} Viewport identifier. Viewport Viewport
*{Location} Location identifier. Geospatial Area
GeometryID
Circle
*from Start date of timeframe. date 2020-01-01
*to End date of timeframe. date 2020-12-31
poi_class Filter POIs with "category": "hotel" by stars rating in the range [1,5]. int 4
poi_industry Filter by POI Industry. string Dictionary
poi_category Filter by POI Category. string Dictionary
facility Filter offers by included facility. string breakfast
lunch
dinner
guests Filter offers by number of allowed guests. int 1 2
refundable Filter offers that can be refunded. boolean true
false
scan_last_day Filter data according to a less recent offers detection in the range [1,10] (from most recent to oldest offers detection day). int 5 1
Supported values for facility
  • breakfast
  • lunch
  • dinner
Example
curl -X GET 'https://api.datappeal.io/v4/ondemand/account/{account_id}/locations/rates/saturation/overall?geometry_id=379c730942e570d586a5520770c0a65d&from=2021-01-01&to=2021-07-01' \
-H 'x-api-key: {x_api_key}' \
-H 'Authorization: Bearer {jwt_bearer}' \
Example /sample
curl -X GET 'https://api.datappeal.io/v4/ondemand/account/{account_id}/locations/rates/sample/saturation/overall?geometry_id=379c730942e570d586a5520770c0a65d&from=2021-01-01&to=2021-07-01' \
-H 'x-api-key: {x_api_key}' \
-H 'Authorization: Bearer {jwt_bearer}' \

Response

Status

Status Description
200 Rates Saturation data has been successfully returned.

Body

LocationRatesSaturation

Field Description Type Examples
*total_offers Total number of accommodation offers. int 1106
*available_offers Number of available accommodation offers. int 729
*saturation Occupancy ratio in the range [0,100] calculated by the following formula.
equation
decimal 34.09
Example
{
    "total_offers": 3679044,
    "available_offers": 2524739,
    "saturation": 31.38
}