Skip to content

Seasonality Balance Compare

Seasonality Balance Compare API returns two different index scores at once: one defined by the specified {Location} and date query parameter and another defined by compare_ prefixed query parameters (or auto-calculated with default values where specified).
Additional comparative data between the two index scores is returned as well.

Request

Endpoint

GET /v4/{billing_plan}/account/{account_id}/locations/index/seasonality_balance/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

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
*date Day for which index actual score is requested. date 2021-01-31
{ComparisonLocation} Comparison location identifier. ComparisonGeospatial ComparisonArea
ComparisonGeometryID
ComparisonCircle		 Same as {Location}.
compare_date Day for which index comparison score is requested. date 2021-01-31 One year before date.
ⓝ network
ⓝ compare_network		 Filter by network. string Dictionary
ⓝ 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
ⓝ user_type
ⓝ compare_user_type		 Filter by reviewer type. string Dictionary
ⓝ user_country
ⓝ compare_user_country		 Filter by reviewer's country of origin in ISO 3166-1 alpha-2 standard format (in lower case). string it
de
ⓝ content_language
ⓝ compare_content_language		 Filter by contents language in ISO_639-1 standard format. string en
fr
Example 
curl -X GET 'https://api.datappeal.io/v4/ondemand/account/{account_id}/locations/index/seasonality_balance/compare?geometry_id=379c730942e570d586a5520770c0a65d&date=2021-01-01&compare_date=2020-07-01' \
-H 'x-api-key: {x_api_key}' \
-H 'Authorization: Bearer {jwt_bearer}' \

Response

Status

Status Description
200 Seasonality Balance Compare data has been successfully returned.

Body

LocationComparedIndex

Field Description Type
actual Index score for the actual timeframe. LocationComparableIndex
comparison Index score for the comparison timeframe. LocationComparableIndex
variation Calculated difference between actual and comparison. Variation
LocationComparableIndex
Field Description Type
timeframe Reference date. LocationIndexDate
value Index score for the corresponding timeframe. LocationIndexScore
LocationIndexDate
Field Description Type
date Date representing the day score refers to.
It could differ by the requested date for calculation resolution reasons.		 date
LocationIndexScore
Field Description Type
score Index score value in the range [0,100]. decimal
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": {
            "date": "2020-12-28"
        },
        "value": {
            "score": 33.13
        }
    },
    "comparison": {
        "timeframe": {
            "date": "2020-06-29"
        },
        "value": {
            "score": 59.21
        }
    },
    "variation": {
        "value": -26.08,
        "variation": "NEGATIVE"
    }
}