Skip to content

Overall Compare

Rates Overall Compare API returns two different rates overall data sets 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 data between the two data sets is returned as well.

Request

Endpoint

GET /v4/{billing_plan}/account/{account_id}/locations/rates/overall/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
{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.
ⓝ percentile Request percentile expressed in the range (0, 1).
Median value 0.5 will always be implicitly requested.		 decimal 0.5
ⓝ 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 facility
  • breakfast
  • lunch
  • dinner
Example 
curl -X GET 'https://api.datappeal.io/v4/ondemand/account/{account_id}/locations/rates/overall/compare?geometry_id=379c730942e570d586a5520770c0a65d&from=2021-01-01&to=2021-07-01&compare_from=2020-07-01&compare_to=2021-01-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/overall/compare?geometry_id=379c730942e570d586a5520770c0a65d&from=2021-01-01&to=2021-07-01&compare_from=2020-07-01&compare_to=2021-01-01' \
-H 'x-api-key: {x_api_key}' \
-H 'Authorization: Bearer {jwt_bearer}' \

Response

Status

Status Description
200 Rates Overall Compare data has been successfully returned.

Body

LocationRatesComparedOverall

Field Description Type
actual Rates overall data for the actual timeframe. LocationRatesComparableOverall
comparison Rates overall data for the comparison timeframe. LocationRatesComparableOverall
variation Calculated difference between actual and comparison. LocationRatesOverallVariation
LocationRatesComparableOverall
Field Description Type
timeframe Reference date range. Timeframe
value Rates overall data for the corresponding timeframe. LocationRatesOverall
Timeframe
Field Description Type
*from Start date of timeframe. date
*to End date of timeframe. date
LocationRatesOverall
Field Description Type Examples
*poi Count of POIs with accommodation offers within the group. PartitionCount
average Average accommodation offers price in Euros. decimal 88.44
*percentiles Accommodation offers percentiles values expressed in Euros. array[Percentile]
PartitionCount
Field Description Type
partition Count incidence percentage of the group's elements over total elements. int
count Total elements of the group. int
Percentile
Field Description Type Examples
*request Requested percentile expressed in the range (0, 1), e.g. 0.5 (the median). decimal 0.5
*response Resulting value of the request percentile. decimal 73.00
LocationRatesOverallVariation
Field Description Type
average Average accommodation offers price variation in Euros. Variation
*percentiles Accommodation offers percentiles variations expressed in Euros. array[PercentileVariation]
poi Count variation of POIs with accommodation offers within the group. PartitionVariation
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
PercentileVariation
Field Description Type Examples
*request Requested percentile expressed in the range (0, 1), e.g. 0.5 (the median). decimal 0.5
*response Resulting variation value of the request percentile. Variation
PartitionVariation
Field Description Type
partition Count incidence percentage variation of the group's elements over total elements. Variation
count Total elements variation of the group. Variation
Value of $.actual,comparison.value.poi.partition

For non-grouped API calls, this value will always be 100.0: since no grouping is taking place, the total is considered as one whole group.

Example 
{
    "actual": {
        "timeframe": {
            "from": "2021-01-01",
            "to": "2021-07-01"
        },
        "value": {
            "poi": {
                "partition": 100.0,
                "count": 2370
            },
            "average": 179.64,
            "percentiles": [
                {
                    "request": 0.5,
                    "response": 110.85377
                }
            ]
        }
    },
    "comparison": {
        "timeframe": {
            "from": "2020-07-01",
            "to": "2021-01-01"
        },
        "value": {
            "poi": {
                "partition": 100.0,
                "count": 618
            },
            "average": 207.92,
            "percentiles": [
                {
                    "request": 0.5,
                    "response": 114.48866
                }
            ]
        }
    },
    "variation": {
        "average": {
            "value": -28.279999,
            "variation": "NEGATIVE"
        },
        "percentiles": [
            {
                "request": 0.5,
                "response": {
                    "value": -3.63,
                    "variation": "NEGATIVE"
                }
            }
        ],
        "poi": {
            "partition": {
                "value": 0.0,
                "variation": "NEUTRAL"
            },
            "count": {
                "value": 1752,
                "variation": "POSITIVE"
            }
        }
    }
}