Travel Barometer Series

Travel Barometer Series API returns a time-based index score series for the specified {Location}, grouped by a time period.

Request

Endpoint

GET /v4/{billing_plan}/account/{account_id}/locations/index/travel_barometer/series

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
*period	Time unit of the series.	string	day week month
ⓝ poi_industry	Filter by POI Industry.	string	Dictionary

Supported values for period

• week
• month

Example

curl -X GET 'https://api.datappeal.io/v4/ondemand/account/{account_id}/locations/index/travel_barometer/series?geometry_id=379c730942e570d586a5520770c0a65d&from=2021-01-01&to=2021-02-28&period=month' \
-H 'x-api-key: {x_api_key}' \
-H 'Authorization: Bearer {jwt_bearer}' \

Response

Status

Status	Description
200	Travel Barometer Series data has been successfully returned.

Body

SeriesIndex

Field	Description	Type
series	Index series data for the requested timeframe and period.	array[LocationSeriesIndexElement]

LocationSeriesIndexElement

Field	Description	Type
*period	Date representing a specific day, corresponding to the first day of the requested period. day: the day itself. week: first day of the corresponding week. month: first day of the corresponding month.	date
*value	Index score of corresponding period.	LocationIndexScore

LocationIndexScore

Field	Description	Type
score	Index score value in the range [0,100].	decimal

Example

{
    "series": [
        {
            "period": "2021-01-01",
            "value": {
                "score": 31.21
            }
        },
        {
            "period": "2021-02-01",
            "value": {
                "score": 25.75
            }
        }
    ]
}