Skip to content

▪ Seasonal Balance Index Compare

Seasonal Balance Index Compare API returns two different index scores 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 index scores is returned as well.

Request

Endpoint

GET /v4/{billing_plan}/account/{account_id}/locations/index/sustainability/destination-management/seasonal-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
*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.
ⓝ poi_industry
ⓝ compare_poi_industry		 Filter by POI Industry. string Dictionary
Example 
curl -X GET 'https://api.datappeal.io/v4/ondemand/account/{account_id}/locations/index/sustainability/destination-management/seasonal-balance/compare?geometry_id=379c730942e570d586a5520770c0a65d&from=2025-01-01&to=2025-11-01' \
-H 'x-api-key: {x_api_key}' \
-H 'Authorization: Bearer {jwt_bearer}' \

Response

Status

Status Description
200 Seasonal Balance Index Compare data has been successfully returned.

Body

LocationComparedIndex

Field Description Type
actual Index score for the actual timeframe. LocationIndexScore
comparison Index score for the comparison timeframe. LocationIndexScore
variation Calculated difference between actual and comparison. Variation
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": {
        "score": 33.13
    },
    "comparison": {
        "score": 59.21
    },
    "variation": {
        "value": -26.08,
        "variation": "NEGATIVE"
    }
}