▪ Overall Compare
Rates Overall Compare API returns two different rates overall data sets at once for a specified {Viewport} and {Location}: one defined by the specified [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}/maps/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}/maps/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} | Actual location identifier. | Geospatial | AreaGeometryIDCircle | |
| *from | Start date of actual timeframe. | date | 2021-01-01 | |
| *to | End date of actual timeframe. | date | 2021-07-01 | |
| 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 | breakfastlunchdinner | |
| guestscompare_guests | Filter offers by number of allowed guests. | int | 1 | 2 |
| refundablecompare_refundable | Filter offers that can be refunded. | boolean | truefalse | |
| 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}/maps/rates/overall/compare?country=italy&state=toscana&county=prato&city=prato&from=2022-07-01&to=2023-07-01&sw_lat=43.06888777416961&sw_lng=8.4375&se_lat=43.06888777416961&se_lng=11.25&ne_lat=45.08903556483103&ne_lng=11.25&nw_lat=45.08903556483103&nw_lng=8.4375' \
-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}/maps/rates/sample/overall/compare?country=italy&state=toscana&county=prato&city=prato&from=2022-07-01&to=2023-07-01&sw_lat=43.06888777416961&sw_lng=8.4375&se_lat=43.06888777416961&se_lng=11.25&ne_lat=45.08903556483103&ne_lng=11.25&nw_lat=45.08903556483103&nw_lng=8.4375' \
-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
MapsRatesComparedOverall
| Field | Description | Type |
|---|---|---|
| actual | Rates overall data for the actual timeframe. | MapsRatesComparableOverall |
| comparison | Rates overall data for the comparison timeframe. | MapsRatesComparableOverall |
| variation | Calculated difference between actual and comparison. |
array[MapsRatesOverallVariation] |
MapsRatesComparableOverall
| Field | Description | Type |
|---|---|---|
| timeframe | Reference date range. | Timeframe |
| value | Rates overall map quads data for the corresponding timeframe. |
array[MapsRatesOverallElement] |
Timeframe
| Field | Description | Type |
|---|---|---|
| *from | Start date of timeframe. | date |
| *to | End date of timeframe. | date |
MapsRatesOverallElement
| Field | Description | Type |
|---|---|---|
| *overall | Overall rates data of corresponding quadkey. |
LocationRatesOverall |
| *quadkey | Identifier of the map quad. | Quadkey |
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 |
Quadkey
| Field | Description | Type | Examples |
|---|---|---|---|
| *tile | Map quad identifier in Bing Maps Tile System standard format. | string | 1202231311 |
| *wkt | Map quad expressed in WKT standard format. | string | POLYGON ((10.8984375 43.83452678223682, 11.25 43.83452678223682, 11.25 44.087585028245165, 10.8984375 44.087585028245165, 10.8984375 43.83452678223682)) |
MapsRatesOverallVariation
| Field | Description | Type |
|---|---|---|
| *compare | Rates overall variation data of corresponding quadkey. |
LocationRatesSaturationVariation |
| *quadkey | Identifier of the map quad. | Quadkey |
LocationRatesSaturationVariation
| 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 |
Quadkey
| Field | Description | Type | Examples |
|---|---|---|---|
| *tile | Map quad identifier in Bing Maps Tile System standard format. | string | 1202231311 |
| *wkt | Map quad expressed in WKT standard format. | string | POLYGON ((10.8984375 43.83452678223682, 11.25 43.83452678223682, 11.25 44.087585028245165, 10.8984375 44.087585028245165, 10.8984375 43.83452678223682)) |
Example
{
"actual": {
"timeframe": {
"from": "2022-07-01",
"to": "2023-01-01"
},
"value": [
{
"overall": {
"average": 107.31,
"percentiles": [
{
"request": 0.5,
"response": 98.04072
}
]
},
"poi": {
"count": 45,
"partition": 96.0
},
"quadkey": {
"tile": "12022313113",
"wkt": "POLYGON ((11.07421875 43.83452678223682, 11.25 43.83452678223682, 11.25 43.96119063892024, 11.07421875 43.96119063892024, 11.07421875 43.83452678223682))"
}
},
{
"overall": {
"average": 75.05,
"percentiles": [
{
"request": 0.5,
"response": 75.0
}
]
},
"poi": {
"count": 1,
"partition": 2.0
},
"quadkey": {
"tile": "12022313112",
"wkt": "POLYGON ((10.8984375 43.83452678223682, 11.07421875 43.83452678223682, 11.07421875 43.96119063892024, 10.8984375 43.96119063892024, 10.8984375 43.83452678223682))"
}
},
{
"overall": {
"average": 98.12,
"percentiles": [
{
"request": 0.5,
"response": 99.121124
}
]
},
"poi": {
"count": 1,
"partition": 2.0
},
"quadkey": {
"tile": "12022313131",
"wkt": "POLYGON ((11.07421875 43.707593504052944, 11.25 43.707593504052944, 11.25 43.83452678223682, 11.07421875 43.83452678223682, 11.07421875 43.707593504052944))"
}
},
{
"overall": {
"average": null,
"percentiles": [
{
"request": 0.5,
"response": null
}
]
},
"poi": {
"count": 0,
"partition": 0.0
},
"quadkey": {
"tile": "12022313130",
"wkt": "POLYGON ((10.8984375 43.707593504052944, 11.07421875 43.707593504052944, 11.07421875 43.83452678223682, 10.8984375 43.83452678223682, 10.8984375 43.707593504052944))"
}
}
]
},
"comparison": {
"timeframe": {
"from": "2021-07-01",
"to": "2022-01-01"
},
"value": [
{
"overall": {
"average": 90.5,
"percentiles": [
{
"request": 0.5,
"response": 84.93077
}
]
},
"poi": {
"count": 36,
"partition": 95.0
},
"quadkey": {
"tile": "12022313113",
"wkt": "POLYGON ((11.07421875 43.83452678223682, 11.25 43.83452678223682, 11.25 43.96119063892024, 11.07421875 43.96119063892024, 11.07421875 43.83452678223682))"
}
},
{
"overall": {
"average": 75.97,
"percentiles": [
{
"request": 0.5,
"response": 75.0
}
]
},
"poi": {
"count": 2,
"partition": 5.0
},
"quadkey": {
"tile": "12022313112",
"wkt": "POLYGON ((10.8984375 43.83452678223682, 11.07421875 43.83452678223682, 11.07421875 43.96119063892024, 10.8984375 43.96119063892024, 10.8984375 43.83452678223682))"
}
},
{
"overall": {
"average": null,
"percentiles": [
{
"request": 0.5,
"response": null
}
]
},
"poi": {
"count": 0,
"partition": 0.0
},
"quadkey": {
"tile": "12022313131",
"wkt": "POLYGON ((11.07421875 43.707593504052944, 11.25 43.707593504052944, 11.25 43.83452678223682, 11.07421875 43.83452678223682, 11.07421875 43.707593504052944))"
}
},
{
"overall": {
"average": null,
"percentiles": [
{
"request": 0.5,
"response": null
}
]
},
"poi": {
"count": 0,
"partition": 0.0
},
"quadkey": {
"tile": "12022313130",
"wkt": "POLYGON ((10.8984375 43.707593504052944, 11.07421875 43.707593504052944, 11.07421875 43.83452678223682, 10.8984375 43.83452678223682, 10.8984375 43.707593504052944))"
}
}
]
},
"variation": [
{
"overall": {
"average": {
"value": 16.809998,
"variation": "POSITIVE"
},
"percentiles": [
{
"request": 0.5,
"response": {
"value": 13.11,
"variation": "POSITIVE"
}
}
]
},
"poi": {
"partition": {
"value": 1.0,
"variation": "POSITIVE"
},
"count": {
"value": 9,
"variation": "POSITIVE"
}
},
"quadkey": {
"tile": "12022313113",
"wkt": "POLYGON ((11.07421875 43.83452678223682, 11.25 43.83452678223682, 11.25 43.96119063892024, 11.07421875 43.96119063892024, 11.07421875 43.83452678223682))"
}
},
{
"overall": {
"average": {
"value": -0.91999817,
"variation": "NEGATIVE"
},
"percentiles": [
{
"request": 0.5,
"response": {
"value": 0.0,
"variation": "NEUTRAL"
}
}
]
},
"poi": {
"partition": {
"value": -3.0,
"variation": "NEGATIVE"
},
"count": {
"value": -1,
"variation": "NEGATIVE"
}
},
"quadkey": {
"tile": "12022313112",
"wkt": "POLYGON ((10.8984375 43.83452678223682, 11.07421875 43.83452678223682, 11.07421875 43.96119063892024, 10.8984375 43.96119063892024, 10.8984375 43.83452678223682))"
}
},
{
"overall": {
"average": {
"value": null,
"variation": null
},
"percentiles": [
{
"request": 0.5,
"response": {
"value": null,
"variation": null
}
}
]
},
"poi": {
"partition": {
"value": 2.0,
"variation": "POSITIVE"
},
"count": {
"value": 1,
"variation": "POSITIVE"
}
},
"quadkey": {
"tile": "12022313131",
"wkt": "POLYGON ((11.07421875 43.707593504052944, 11.25 43.707593504052944, 11.25 43.83452678223682, 11.07421875 43.83452678223682, 11.07421875 43.707593504052944))"
}
},
{
"overall": {
"average": {
"value": null,
"variation": null
},
"percentiles": [
{
"request": 0.5,
"response": {
"value": null,
"variation": null
}
}
]
},
"poi": {
"partition": {
"value": 0.0,
"variation": "NEUTRAL"
},
"count": {
"value": 0,
"variation": "NEUTRAL"
}
},
"quadkey": {
"tile": "12022313130",
"wkt": "POLYGON ((10.8984375 43.707593504052944, 11.07421875 43.707593504052944, 11.07421875 43.83452678223682, 10.8984375 43.83452678223682, 10.8984375 43.707593504052944))"
}
}
]
}