Skip to content

▪ List POIs

List POIs API returns a paginated list of the 1000 most relevant POIs, with the highest number of contents in the specified timeframe, within the specified {Location}, along with reputation quantitative and qualitative KPIs for each POI.

Request

Endpoint

GET /v4/{billing_plan}/account/{account_id}/locations/poi/list

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}/locations/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 Defaults
*{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
page Requested page number for paginated results. int 1
page_size Requested page size for paginated results in the range [1, 100]. int 25
Example 
curl -X GET 'https://api.datappeal.io/v4/account/{account_id}/locations/poi/list?country=italy&state=toscana&county=firenze&city=firenze&from=2021-01-01&to=2021-07-01&page_size=2' \
-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}/locations/sample/poi/list?country=italy&state=toscana&county=firenze&city=firenze&from=2021-01-01&to=2021-07-01&page_size=2' \
-H 'x-api-key: {x_api_key}' \
-H 'Authorization: Bearer {jwt_bearer}' \

Response

Status

Status Description
200 List POIs data has been successfully returned.

Body

POIsReputation

Field Description Type Examples
*results Paginated list of POIs. array[POIReputation]
paging Response pagination. Paging
POIReputation
Field Description Type Examples
*name Description of the POI. string Piazza del Duomo
*contents Total count of contents. Total
*sentiment KPI which indicates users global satisfaction. PolarizedValue
*location Location of the POI in spatial coordinates. Coordinates
*poi_category Identifies the sub-typology of the POI. string Dictionary
*poi_industry Identifies the super-typology of the POI. string Dictionary
*city City to which the POI belongs. string Firenze
*address Textual address of the POI. string Piazza del Duomo
picture URL of an image related to the POI. string https://media-cdn.tripadvisor.com/media/photo-s/0d/8f/e0/42/solarium.jpg
Total
Field Description Type
total Total count of elements. int
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
Coordinates
Field Description Type Examples
*latitude Latitude expressed in the range [-90, 90]. decimal 43.7730912
*longitude Longitude expressed in the range [-180, 180]. decimal 11.2554649
Paging
Field Description Type
last A relative URI to the last page. string
first A relative URI to the first page. string
prev A relative URI to the previous page. string
next A relative URI to the next page. string
current A relative URI to the current page. string
pages A set of relative URIs calculated around the current page. Page
elements All indexes shown on the current page. array[int]
total The number of all elements that API can retrieve. int
size The selected page size. int
Page
Field Description Type
number Number of the page. int
uri URI of the page. string
Example 
{
    "results": [
        {
            "name": "Piazza del Duomo",
            "contents": {
                "total": 2516
            },
            "sentiment": {
                "value": 96.95,
                "polarity": "POSITIVE"
            },
            "location": {
                "latitude": 43.7730912,
                "longitude": 11.2554649
            },
            "poi_type": "cultural",
            "poi_category": "square",
            "poi_industry": "attractions",
            "city": "firenze"
        },
        {
            "name": "Ponte Vecchio",
            "contents": {
                "total": 2416
            },
            "sentiment": {
                "value": 95.67,
                "polarity": "POSITIVE"
            },
            "location": {
                "latitude": 43.767925,
                "longitude": 11.2531435
            },
            "poi_type": "cultural",
            "poi_category": "bridge",
            "poi_industry": "attractions",
            "city": "firenze"
        }
    ],
    "paging": {
        "last": "/poi/list?page=500&page_size=2&country=italy&county=firenze&from=2021-01-01&state=toscana&to=2021-07-01",
        "first": "/poi/list?page=1&page_size=2&country=italy&county=firenze&from=2021-01-01&state=toscana&to=2021-07-01",
        "prev": null,
        "next": "/poi/list?page=2&page_size=2&country=italy&county=firenze&from=2021-01-01&state=toscana&to=2021-07-01",
        "current": "/poi/list?page=1&page_size=2&country=italy&county=firenze&from=2021-01-01&state=toscana&to=2021-07-01",
        "pages": [
            {
                "number": 1,
                "uri": "/poi/list?page=1&page_size=2&country=italy&county=firenze&from=2021-01-01&state=toscana&to=2021-07-01"
            },
            {
                "number": 2,
                "uri": "/poi/list?page=2&page_size=2&country=italy&county=firenze&from=2021-01-01&state=toscana&to=2021-07-01"
            },
            {
                "number": 3,
                "uri": "/poi/list?page=3&page_size=2&country=italy&county=firenze&from=2021-01-01&state=toscana&to=2021-07-01"
            },
            {
                "number": 4,
                "uri": "/poi/list?page=4&page_size=2&country=italy&county=firenze&from=2021-01-01&state=toscana&to=2021-07-01"
            },
            {
                "number": 5,
                "uri": "/poi/list?page=5&page_size=2&country=italy&county=firenze&from=2021-01-01&state=toscana&to=2021-07-01"
            }
        ],
        "elements": [
            1,
            2
        ],
        "total": 1000,
        "size": 2
    }
}