Skip to content

▪ Overall

Overall API returns overall data for the specified {Viewport} within the specified {Location}.

Request

Endpoint

GET /v4/{billing_plan}/account/{account_id}/maps/overall

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
/sample Filter data for POIs that are included in the sample (subset of POIs that statistically replicates the population of the corresponding location). string
/sample optional path parameter

Inserting optional path parameter /sample in the following position:

  • /v4/{billing_plan}/account/{account_id}/maps/sample/…

will filter data for POIs that are included in the sample (subset of POIs that statistically replicates the population of the corresponding location).

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
*{Viewport} Viewport identifier. Viewport Viewport
*{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
ⓝ 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
ⓝ content_type Filter by type of content. string post
review
taggedpost		 review && taggedpost
Supported values for content_type
  • review
  • post
  • taggedpost
Example 
curl -X GET 'https://api.datappeal.io/v4/account/{account_id}/maps/overall?country=italy&state=toscana&county=prato&from=2021-01-01&to=2021-07-01&sw_lat=43.06888777416961&sw_lng=8.4375&se_lat=43.06888777416961&se_lng=11.25&ne_lat=45.08903556483103&ne_lng=11.25&nw_lat=45.08903556483103&nw_lng=8.4375' \
-H 'x-api-key: {x_api_key}' \
-H 'Authorization: Bearer {jwt_bearer}' \
Example /sample 
curl -X GET 'https://api.datappeal.io/v4/account/{account_id}/maps/sample/overall?country=italy&state=toscana&county=prato&from=2021-01-01&to=2021-07-01&sw_lat=43.06888777416961&sw_lng=8.4375&se_lat=43.06888777416961&se_lng=11.25&ne_lat=45.08903556483103&ne_lng=11.25&nw_lat=45.08903556483103&nw_lng=8.4375' \
-H 'x-api-key: {x_api_key}' \
-H 'Authorization: Bearer {jwt_bearer}' \

Response

Status

Status Description
200 Overall data has been successfully returned.

Body

MapsOverall

Field Description Type
tiles Overall map quads data for requested {Viewport} and {Location}. array[MapsOverallElement]
MapsOverallElement
Field Description Type
*overall Overall data of corresponding quadkey. LocationOverall
*quadkey Identifier of the map quad. Quadkey
LocationOverall
Field Description Type
sentiment KPI which indicates users global satisfaction. PolarizedValue
contents Total and grouped by polarity count of contents. PolarizedCount
poi Count of POIs within the group. PartitionCount
PolarizedValue
Field Description Type Examples
value Value of the including field in the range [0,100]. decimal 60.3
59.7
polarity Polarity of the corresponding value. string POSITIVE
NEGATIVE
PolarizedCount
Field Description Type
positive Positive elements count. int
negative Negative elements count. int
neutral Neutral elements count. int
total Total elements count. int
PartitionCount
Field Description Type
partition Count incidence percentage of the group's elements over total elements. int
count Total elements of the group. int
Quadkey
Field Description Type Examples
*tile Map quad identifier in Bing Maps Tile System standard format. string 1202231311
*wkt Map quad expressed in WKT standard format. string POLYGON ((10.8984375 43.83452678223682, 11.25 43.83452678223682, 11.25 44.087585028245165, 10.8984375 44.087585028245165, 10.8984375 43.83452678223682))
Example 
{
    "tiles": [
        {
            "overall": {
                "sentiment": {
                    "value": 88.79,
                    "polarity": "POSITIVE"
                },
                "contents": {
                    "positive": 15005,
                    "negative": 1145,
                    "neutral": 39,
                    "total": 16189
                },
                "poi": {
                    "count": 1361,
                    "partition": 88.0
                }
            },
            "quadkey": {
                "tile": "1202231311",
                "wkt": "POLYGON ((10.8984375 43.83452678223682, 11.25 43.83452678223682, 11.25 44.087585028245165, 10.8984375 44.087585028245165, 10.8984375 43.83452678223682))"
            }
        },
        {
            "overall": {
                "sentiment": {
                    "value": 90.0,
                    "polarity": "POSITIVE"
                },
                "contents": {
                    "positive": 1612,
                    "negative": 105,
                    "neutral": 1,
                    "total": 1718
                },
                "poi": {
                    "count": 163,
                    "partition": 11.0
                }
            },
            "quadkey": {
                "tile": "1202231313",
                "wkt": "POLYGON ((10.8984375 43.58039085560784, 11.25 43.58039085560784, 11.25 43.83452678223682, 10.8984375 43.83452678223682, 10.8984375 43.58039085560784))"
            }
        },
        {
            "overall": {
                "sentiment": {
                    "value": 88.54,
                    "polarity": "POSITIVE"
                },
                "contents": {
                    "positive": 73,
                    "negative": 4,
                    "neutral": 0,
                    "total": 77
                },
                "poi": {
                    "count": 15,
                    "partition": 1.0
                }
            },
            "quadkey": {
                "tile": "1202231133",
                "wkt": "POLYGON ((10.8984375 44.087585028245165, 11.25 44.087585028245165, 11.25 44.339565248097124, 10.8984375 44.339565248097124, 10.8984375 44.087585028245165))"
            }
        }
    ]
}