Skip to content

▪ Seasonal Peak

Seasonal Peak API returns the index score for the specified {Location}.

Request

Endpoint

GET /v4/{billing_plan}/account/{account_id}/locations/index/seasonality

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
*date Day for which index score is requested. date 2021-01-31
ⓝ network Filter by network. string Dictionary
ⓝ poi_class Filter POIs with "category": "hotel" by stars rating in the range [1,5]. int 4
ⓝ poi_industry Filter by POI Industry. string Dictionary
ⓝ poi_category Filter by POI Category. string Dictionary
ⓝ user_type Filter by reviewer type. string Dictionary
ⓝ 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 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?geometry_id=379c730942e570d586a5520770c0a65d&date=2022-07-28' \
-H 'x-api-key: {x_api_key}' \
-H 'Authorization: Bearer {jwt_bearer}' \

Response

Status

Status Description
200 Seasonal Peak 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": "2022-07-28",
    "score": 113.13
}