▪ Overall Series
Overall Series API returns a time-based overall data series for the specified {Location}
, grouped by a time period.
Request
Endpoint
GET
/v4/{billing_plan}/account/{account_id}/locations/overall/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 |
|
/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:
will filter data for POIs that are included in the sample (subset of POIs that statistically replicates the population of the corresponding location).
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 |
AreaGeometryIDCircle |
|
*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 |
weekmonth |
|
ⓝ 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 |
itde |
|
ⓝ content_language |
Filter by contents language in ISO_639-1 standard format. |
string |
enfr |
|
ⓝ content_type |
Filter by type of content. |
string |
postreviewtaggedpost |
review && taggedpost |
Supported values for period
Supported values for content_type
Example
curl -X GET 'https://api.datappeal.io/v4/ondemand/account/{account_id}/locations/overall/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}' \
Example /sample
curl -X GET 'https://api.datappeal.io/v4/ondemand/account/{account_id}/locations/sample/overall/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 |
Overall Series data has been successfully returned. |
Body
LocationSeriesOverall
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 |
Value of $.series[*].value.poi.partition
For non-grouped API calls, this value will always be 100.0
: since no grouping is taking place, the total is considered as one whole group.
Example
{
"series": [
{
"period": "2021-01-01",
"value": {
"sentiment": {
"value": 88.06,
"polarity": "POSITIVE"
},
"contents": {
"positive": 15571,
"negative": 1423,
"neutral": 1448,
"total": 18442
},
"poi": {
"partition": 100.0,
"count": 4646
}
}
},
{
"period": "2021-02-01",
"value": {
"sentiment": {
"value": 88.87,
"polarity": "POSITIVE"
},
"contents": {
"positive": 16030,
"negative": 1258,
"neutral": 514,
"total": 17802
},
"poi": {
"partition": 100.0,
"count": 4912
}
}
}
]
}