Skip to content

Sentiment Index

Sentiment Index API returns the index score for the specified {Location}.

Request

Endpoint

GET /v4/{billing_plan}/account/{account_id}/locations/index/sustainability/destination-management/sentiment

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                
*{Location} Location identifier. Geospatial Area
GeometryID
Circle
*from Start date of timeframe. date 2020-01-01
*to End date of timeframe. date 2020-12-31
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/sentiment?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 Sentiment Index data has been successfully returned.

Body

LocationIndexScore

Field Description Type
score Index score value in the range [0,100]. decimal
Example
{
    "score": 33.13
}