Overall Series Grouped

Overall Series Grouped API returns a time-based overall data series for the specified {Location}, grouped by time unit (period) and another additional field (group_type).

Request

Endpoint

GET /v4/{billing_plan}/account/{account_id}/locations/overall/series/grouped

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	Default
*{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	week month
*group_type	Field for which perform grouping.	string	poi_industry poi_category poi_class
ⓝ 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

Supported values for period

week
month

Supported values for group_type

network
poi_industry
poi_category
poi_class
user_country
content_language
user_type

Supported values for content_type

review
post
taggedpost

Example

curl -X GET 'https://api.datappeal.io/v4/ondemand/account/{account_id}/locations/overall/series/grouped?geometry_id=379c730942e570d586a5520770c0a65d&from=2021-01-01&to=2021-02-28&period=month&group_type=network&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/ondemand/account/{account_id}/locations/sample/overall/series/grouped?geometry_id=379c730942e570d586a5520770c0a65d&from=2021-01-01&to=2021-02-28&period=month&group_type=network&page_size=2' \
-H 'x-api-key: {x_api_key}' \
-H 'Authorization: Bearer {jwt_bearer}' \

Response

Status

Status	Description
200	Overall Series Grouped data has been successfully returned.

Body

LocationGroupedSeriesOverall

Name	Description	Type
*results	Paginated list of time-based overall data series grouped by `group_type` requested field.	array[LocationGroupedSeriesOverallElement]
paging	Response pagination.	Paging

LocationGroupedSeriesOverallElement

Field	Description	Type
*group	Field value within the requested grouping by field.	string
*series	Overall data series of corresponding `group`.	array[LocationSeriesOverallElement]

LocationSeriesOverallElement

Field	Description	Type
*period	Date representing the requested period, corresponding to the first day of the period. `week`: first day of the corresponding week. `month`: first day of the corresponding month.	date
*value	Overall data of corresponding `period`.	LocationOverall

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

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": [
        {
            "group": "tripadvisor",
            "series": [
                {
                    "period": "2021-01-01",
                    "value": {
                        "sentiment": {
                            "value": 89.7,
                            "polarity": "POSITIVE"
                        },
                        "contents": {
                            "positive": 12008,
                            "negative": 757,
                            "neutral": 0,
                            "total": 12765
                        },
                        "poi": {
                            "partition": 62.4,
                            "count": 3566
                        }
                    }
                },
                {
                    "period": "2021-02-01",
                    "value": {
                        "sentiment": {
                            "value": 89.47,
                            "polarity": "POSITIVE"
                        },
                        "contents": {
                            "positive": 11829,
                            "negative": 767,
                            "neutral": 0,
                            "total": 12596
                        },
                        "poi": {
                            "partition": 61.19,
                            "count": 3699
                        }
                    }
                }
            ]
        },
        {
            "group": "facebook",
            "series": [
                {
                    "period": "2021-01-01",
                    "value": {
                        "sentiment": {
                            "value": 70.73,
                            "polarity": "POSITIVE"
                        },
                        "contents": {
                            "positive": 863,
                            "negative": 410,
                            "neutral": 1448,
                            "total": 2721
                        },
                        "poi": {
                            "partition": 13.12,
                            "count": 750
                        }
                    }
                },
                {
                    "period": "2021-02-01",
                    "value": {
                        "sentiment": {
                            "value": 78.09,
                            "polarity": "POSITIVE"
                        },
                        "contents": {
                            "positive": 587,
                            "negative": 185,
                            "neutral": 514,
                            "total": 1286
                        },
                        "poi": {
                            "partition": 10.72,
                            "count": 648
                        }
                    }
                }
            ]
        }
    ],
    "paging": {
        "last": "/overall/series/grouped?page=7&page_size=2&period=month&geometry_id=379c730942e570d586a5520770c0a65d&from=2021-01-01&group_type=network&to=2021-02-28",
        "first": "/overall/series/grouped?page=1&page_size=2&period=month&geometry_id=379c730942e570d586a5520770c0a65d&from=2021-01-01&group_type=network&to=2021-02-28",
        "prev": null,
        "next": "/overall/series/grouped?page=2&page_size=2&period=month&geometry_id=379c730942e570d586a5520770c0a65d&from=2021-01-01&group_type=network&to=2021-02-28",
        "current": "/overall/series/grouped?page=1&page_size=2&period=month&geometry_id=379c730942e570d586a5520770c0a65d&from=2021-01-01&group_type=network&to=2021-02-28",
        "pages": [
            {
                "number": 1,
                "uri": "/overall/series/grouped?page=1&page_size=2&period=month&geometry_id=379c730942e570d586a5520770c0a65d&from=2021-01-01&group_type=network&to=2021-02-28"
            },
            {
                "number": 2,
                "uri": "/overall/series/grouped?page=2&page_size=2&period=month&geometry_id=379c730942e570d586a5520770c0a65d&from=2021-01-01&group_type=network&to=2021-02-28"
            },
            {
                "number": 3,
                "uri": "/overall/series/grouped?page=3&page_size=2&period=month&geometry_id=379c730942e570d586a5520770c0a65d&from=2021-01-01&group_type=network&to=2021-02-28"
            },
            {
                "number": 4,
                "uri": "/overall/series/grouped?page=4&page_size=2&period=month&geometry_id=379c730942e570d586a5520770c0a65d&from=2021-01-01&group_type=network&to=2021-02-28"
            },
            {
                "number": 5,
                "uri": "/overall/series/grouped?page=5&page_size=2&period=month&geometry_id=379c730942e570d586a5520770c0a65d&from=2021-01-01&group_type=network&to=2021-02-28"
            }
        ],
        "elements": [
            1,
            2
        ],
        "total": 14,
        "size": 2
    }
}