▪ Travel Barometer
Travel Barometer API returns the index score for the specified {Location}.
Request
Endpoint
GET
/v4/{billing_plan}/account/{account_id}/locations/index/travel_barometer
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 |
|
| 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 |
Examples |
| *{Location} |
Location identifier. |
Geospatial |
AreaGeometryIDCircle |
|
| *date |
Day for which index score is requested. |
date |
2021-01-31 |
|
| ⓝ poi_industry |
Filter by POI Industry. |
string |
Dictionary |
|
Example
curl -X GET 'https://api.datappeal.io/v4/ondemand/account/{account_id}/locations/index/travel_barometer?geometry_id=379c730942e570d586a5520770c0a65d&date=2021-01-01' \
-H 'x-api-key: {x_api_key}' \
-H 'Authorization: Bearer {jwt_bearer}' \
Response
Status
| Status |
Description |
| 200 |
Travel Barometer data has been successfully returned. |
Body
LocationIndexDateScore
| Field |
Description |
Type |
| date |
Date representing the day score refers to.
It could differ by the requested date for calculation resolution reasons. |
date |
| score |
Index score value in the range [0,100]. |
decimal |
Example
{
"date": "2020-12-28",
"score": 33.13
}