Skip to content

▪ Saturation Series Compare

Rates Saturation Series Compare API returns two, time-based rates saturation data series at once: one defined by the specified {Location} and [from,to] query parameters and another defined by compare_ prefixed query parameters (or auto-calculated with default values where specified).
Additional comparative time-based data series between the two data series are returned as well.

Request

Endpoint

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

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/rates/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} Actual location identifier. Geospatial Area
GeometryID
Circle
*from Start date of actual timeframe. date 2020-01-01
*to End date of actual timeframe. date 2020-12-31
*period Time unit of the series. string day
week
month
{ComparisonLocation} Comparison location identifier. ComparisonGeospatial ComparisonArea
ComparisonGeometryID
ComparisonCircle		 Same as {Location}.
compare_from Start date of comparison timeframe. date 2020-07-01 One year before from.
compare_to End date of comparison timeframe. date 2021-01-01 One year before to.
ⓝ poi_class
ⓝ compare_poi_class		 Filter POIs with "category": "hotel" by stars rating in the range [1,5]. int 4
ⓝ poi_industry
ⓝ compare_poi_industry		 Filter by POI Industry. string Dictionary
ⓝ poi_category
ⓝ compare_poi_category		 Filter by POI Category. string Dictionary
ⓝ facility
ⓝ compare_facility		 Filter offers by included facility. string breakfast
lunch
dinner
guests
compare_guests		 Filter offers by number of allowed guests. int 1 2
refundable
compare_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 period
  • day
  • week
  • month
Supported values for facility
  • breakfast
  • lunch
  • dinner
Example 
curl -X GET 'https://api.datappeal.io/v4/ondemand/account/{account_id}/locations/rates/saturation/overall/series/compare?geometry_id=379c730942e570d586a5520770c0a65d&from=2021-01-01&to=2021-02-28&compare_from=2020-11-01&compare_to=2020-12-31&period=month' \
-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/series/compare?geometry_id=379c730942e570d586a5520770c0a65d&from=2021-01-01&to=2021-02-28&compare_from=2020-11-01&compare_to=2020-12-31&period=month' \
-H 'x-api-key: {x_api_key}' \
-H 'Authorization: Bearer {jwt_bearer}' \

Response

Status

Status Description
200 Rates Saturation Series Compare data has been successfully returned.

Body

LocationRatesComparedSeriesSaturation

Field Description Type
actual Rates saturation data series for the actual timeframe. LocationRatesComparableSeriesSaturation
comparison Rates saturation data series for the comparison timeframe. LocationRatesComparableSeriesSaturation
variation Calculated difference between actual and comparison. LocationRatesSeriesSaturationVariation
LocationRatesComparableSeriesSaturation
Field Description Type
timeframe Reference date range. Timeframe
value Rates saturation data series for the corresponding timeframe. LocationRatesSeriesSaturation
Timeframe
Field Description Type
*from Start date of timeframe. date
*to End date of timeframe. date
LocationRatesSeriesSaturation
Field Description Type
series Rates saturation data series for the requested timeframe and period. array[LocationRatesSeriesSaturationElement]
LocationRatesSeriesSaturationElement
Field Description Type
*period Date representing the requested period, corresponding to the first day of the period.
day: the day itself.
week: first day of the corresponding week.
month: first day of the corresponding month.		 date
*value Rates saturation data of corresponding period. LocationRatesSaturation
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
LocationRatesSeriesSaturationVariation
Field Description Type
series Rates saturation data series for the requested timeframe and period. array[LocationRatesSeriesSaturationVariationElement]
LocationRatesSeriesSaturationVariationElement
Field Description Type
*actual_period Date representing the actual period, corresponding to the first day of the period.
day: the day itself.
week: first day of the corresponding week.
month: first day of the corresponding month.		 date
*comparison_period Date representing the comparison period, corresponding to the first day of the period.
day: the day itself.
week: first day of the corresponding week.
month: first day of the corresponding month.		 date
*value Rates saturation variation data between actual_period and comparison_period. LocationRatesSaturationVariation
LocationRatesSaturationVariation
Field Description Type
*total_offers Variation of accommodation offers. Variation
*available_offers Variation of available accommodation offers. Variation
*saturation Occupancy ratio variation. Variation
Variation
Field Description Type Examples
value Difference between actual value and comparison value. decimal 1.12
variation The explicit variation polarity.
It is null when values are not available in both timeframes.		 string POSITIVE
NEUTRAL
NEGATIVE
Example 
{
    "actual": {
        "timeframe": {
            "from": "2021-01-01",
            "to": "2021-02-28"
        },
        "value": {
            "series": [
                {
                    "period": "2021-01-01",
                    "value": {
                        "total_offers": 339729,
                        "available_offers": 227484,
                        "saturation": 33.04
                    }
                },
                {
                    "period": "2021-02-01",
                    "value": {
                        "total_offers": 383273,
                        "available_offers": 248195,
                        "saturation": 35.24
                    }
                }
            ]
        }
    },
    "comparison": {
        "timeframe": {
            "from": "2020-11-01",
            "to": "2020-12-31"
        },
        "value": {
            "series": [
                {
                    "period": "2020-11-01",
                    "value": {
                        "total_offers": 335875,
                        "available_offers": 169425,
                        "saturation": 49.56
                    }
                },
                {
                    "period": "2020-12-01",
                    "value": {
                        "total_offers": 347121,
                        "available_offers": 195613,
                        "saturation": 43.65
                    }
                }
            ]
        }
    },
    "variation": {
        "series": [
            {
                "actual_period": "2021-01-01",
                "comparison_period": "2020-11-01",
                "value": {
                    "total_offers": {
                        "value": 3854,
                        "variation": "POSITIVE"
                    },
                    "available_offers": {
                        "value": 58059,
                        "variation": "POSITIVE"
                    },
                    "saturation": {
                        "value": -16.520000000000003,
                        "variation": "NEGATIVE"
                    }
                }
            },
            {
                "actual_period": "2021-02-01",
                "comparison_period": "2020-12-01",
                "value": {
                    "total_offers": {
                        "value": 36152,
                        "variation": "POSITIVE"
                    },
                    "available_offers": {
                        "value": 52582,
                        "variation": "POSITIVE"
                    },
                    "saturation": {
                        "value": -8.409999999999997,
                        "variation": "NEGATIVE"
                    }
                }
            }
        ]
    }
}