Skip to content

Saturation Grouped

Rates Saturation Grouped API returns accommodation occupancy data for the specified {Location} grouped by the field defined by the group_type query parameter.



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

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
*{Location} Location identifier. Geospatial Area
*from Start date of timeframe. date 2020-01-01
*to End date of timeframe. date 2020-12-31
*group_type Field for which perform grouping. string poi_industry
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
guests Filter offers by number of allowed guests. int 1 2
refundable Filter offers that can be refunded. boolean true
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
page Requested page number for paginated results. int 1
page_size Requested page size for paginated results in the range [1, 100]. int 25
Supported values for facility
  • breakfast
  • lunch
  • dinner
curl -X GET '{account_id}/locations/rates/saturation/overall/grouped?geometry_id=379c730942e570d586a5520770c0a65d&from=2021-01-01&to=2021-07-01&group_type=poi_class' \
-H 'x-api-key: {x_api_key}' \
-H 'Authorization: Bearer {jwt_bearer}' \
Example /sample
curl -X GET '{account_id}/locations/rates/sample/saturation/overall/grouped?geometry_id=379c730942e570d586a5520770c0a65d&from=2021-01-01&to=2021-07-01&group_type=poi_class' \
-H 'x-api-key: {x_api_key}' \
-H 'Authorization: Bearer {jwt_bearer}' \



Status Description
200 Rates Saturation Grouped data has been successfully returned.



Field Description Type
*results Paginated list of rates saturation data grouped by group_type requested field. array[LocationRatesGroupedSaturationElement]
paging Response pagination. Paging
Field Description Type Examples
*group Field value within the requested grouping by field. string
*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.
decimal 34.09
Field Description Type
last A relative URI to the last page. string
first A relative URI to the first page. string
prev A relative URI to the previous page. string
next A relative URI to the next page. string
current A relative URI to the current page. string
pages A set of relative URIs calculated around the current page. Page
elements All indexes shown on the current page. array[int]
total The number of all elements that API can retrieve. int
size The selected page size. int
Field Description Type
number Number of the page. int
uri URI of the page. string
    "results": [
            "group": "1",
            "total_offers": 26910,
            "available_offers": 23777,
            "saturation": 11.64
            "group": "2",
            "total_offers": 105704,
            "available_offers": 82501,
            "saturation": 21.95
            "group": "3",
            "total_offers": 535204,
            "available_offers": 403615,
            "saturation": 24.59
            "group": "4",
            "total_offers": 1471946,
            "available_offers": 957075,
            "saturation": 34.98
            "group": "5",
            "total_offers": 406217,
            "available_offers": 222759,
            "saturation": 45.16
    "paging": {
        "last": "/rates/saturation/overall/grouped?page=1&page_size=25&geometry_id=379c730942e570d586a5520770c0a65d&from=2021-01-01&group_type=poi_class&to=2021-07-01",
        "first": "/rates/saturation/overall/grouped?page=1&page_size=25&geometry_id=379c730942e570d586a5520770c0a65d&from=2021-01-01&group_type=poi_class&to=2021-07-01",
        "prev": null,
        "next": null,
        "current": "/rates/saturation/overall/grouped?page=1&page_size=25&geometry_id=379c730942e570d586a5520770c0a65d&from=2021-01-01&group_type=poi_class&to=2021-07-01",
        "pages": [
                "number": 1,
                "uri": "/rates/saturation/overall/grouped?page=1&page_size=25&geometry_id=379c730942e570d586a5520770c0a65d&from=2021-01-01&group_type=poi_class&to=2021-07-01"
        "total": 5,
        "size": 25,
        "elements": [