▪ Overall Series Grouped Compare
Overall Series Grouped Compare API returns two, time-based overall grouped data series along with a comparative calculation.
Request
Endpoint
GET
/v4/{billing_plan}/account/{account_id}/locations/overall/series/grouped/compare
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} | Actual location identifier. | Geospatial | AreaGeometryIDCircle | |
| *from | Start date of actual timeframe. | date | 2021-01-01 | |
| *to | End date of actual timeframe. | date | 2021-07-01 | |
| *period | Time unit of the series. | string | weekmonth | |
| *group_type | Field for which perform grouping. | string | poi_industrypoi_categorypoi_class | |
| {ComparisonLocation} | Comparison location identifier. | Comparison |
ComparisonAreaComparisonGeometryIDComparisonCircle | Same as {Location}. |
| compare_from | Start date of comparison timeframe. | date | 2020-07-01 | One year before from. |
| compare_to | End date of comparison timeframe. | date | 2021-01-01 | One year before to. |
| ⓝ networkⓝ compare_network | Filter by network. | string | Dictionary | |
| ⓝ poi_classⓝ compare_poi_class | Filter POIs with "category": "hotel" by stars rating in the range [1,5]. |
int | 4 | |
| ⓝ poi_industryⓝ compare_poi_industry | Filter by POI Industry. | string | Dictionary | |
| ⓝ poi_categoryⓝ compare_poi_category | Filter by POI Category. | string | Dictionary | |
| ⓝ user_typeⓝ compare_user_type | Filter by reviewer type. | string | Dictionary | |
| ⓝ user_countryⓝ compare_user_country | Filter by reviewer's country of origin in ISO 3166-1 alpha-2 standard format (in lower case). | string | itde | |
| ⓝ content_languageⓝ compare_content_language | Filter by contents language in ISO_639-1 standard format. | string | enfr | |
| ⓝ content_typeⓝ compare_content_type | Filter by type of content. | string | postreviewtaggedpost | 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
Example
curl -X GET 'https://api.datappeal.io/v4/ondemand/account/{account_id}/locations/overall/series/grouped/compare?geometry_id=379c730942e570d586a5520770c0a65d&from=2021-01-01&to=2021-02-28&compare_from=2020-11-01&compare_to=2020-12-31&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/compare?geometry_id=379c730942e570d586a5520770c0a65d&from=2021-01-01&to=2021-02-28&compare_from=2020-11-01&compare_to=2020-12-31&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 Compare data has been successfully returned. |
Body
LocationGroupedComparedSeriesOverall
| Field | Description | Type |
|---|---|---|
| *results | Paginated grouped compared overall data series. | LocationGroupedComparedSeriesOverallResults |
| paging | Response pagination. | Paging |
LocationGroupedComparedSeriesOverallResults
| Field | Description | Type |
|---|---|---|
| actual | Overall data series for the actual timeframe. | LocationGroupedComparableSeriesOverall |
| comparison | Overall data series for the comparison timeframe. | LocationGroupedComparableSeriesOverall |
| variation | Calculated difference between actual and comparison. |
array[LocationSeriesGroupedOverallVariation] |
LocationGroupedComparableSeriesOverall
| Field | Description | Type |
|---|---|---|
| timeframe | Reference date range. | Timeframe |
| value | Overall grouped data series for the corresponding timeframe. |
array[LocationGroupedSeriesOverallElement] |
Timeframe
| Field | Description | Type |
|---|---|---|
| *from | Start date of timeframe. | date |
| *to | End date of timeframe. | date |
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 |
LocationSeriesGroupedOverallVariation
| Field | Description | Type |
|---|---|---|
| *type | Field value within the requested grouping by field. | string |
| *series | Overall data variation series for the requested timeframe and period. | array[LocationSeriesOverallVariationElement] |
LocationSeriesOverallVariationElement
| Field | Description | Type |
|---|---|---|
| *actual_period | Date representing the actual period, corresponding to the first day of the period.week: first day of the corresponding week.month: first day of the corresponding month. |
date |
| *comparison_period | Date representing the comparison 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 variation data between actual_period and comparison_period. |
LocationOverallVariation |
LocationOverallVariation
| Field | Description | Type |
|---|---|---|
| sentiment | Sentiment variation. | Variation |
| contents | Grouped by polarity variation of contents. | PolarizedVariation |
| poi | Variation of POIs within the location. | PartitionVariation |
Variation
| Field | Description | Type | Examples |
|---|---|---|---|
| value | Difference between actual value and comparison value. |
decimal | 1.12 |
| variation | The explicit variation polarity. It is null when values are not available in both timeframes. |
string | POSITIVE NEUTRAL NEGATIVE |
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": {
"actual": {
"timeframe": {
"from": "2021-01-01",
"to": "2021-02-28"
},
"value": [
{
"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
}
}
}
]
}
]
},
"comparison": {
"timeframe": {
"from": "2020-11-01",
"to": "2020-12-31"
},
"value": [
{
"group": "tripadvisor",
"series": [
{
"period": "2020-11-01",
"value": {
"sentiment": {
"value": 88.98,
"polarity": "POSITIVE"
},
"contents": {
"positive": 10696,
"negative": 758,
"neutral": 0,
"total": 11454
},
"poi": {
"partition": 59.11,
"count": 3566
}
}
},
{
"period": "2020-12-01",
"value": {
"sentiment": {
"value": 88.95,
"polarity": "POSITIVE"
},
"contents": {
"positive": 8487,
"negative": 612,
"neutral": 0,
"total": 9099
},
"poi": {
"partition": 65.31,
"count": 2943
}
}
}
]
},
{
"group": "facebook",
"series": [
{
"period": "2020-11-01",
"value": {
"sentiment": {
"value": 80.07,
"polarity": "POSITIVE"
},
"contents": {
"positive": 587,
"negative": 181,
"neutral": 464,
"total": 1232
},
"poi": {
"partition": 9.85,
"count": 594
}
}
},
{
"period": "2020-12-01",
"value": {
"sentiment": {
"value": 73.24,
"polarity": "POSITIVE"
},
"contents": {
"positive": 656,
"negative": 285,
"neutral": 775,
"total": 1716
},
"poi": {
"partition": 13.85,
"count": 624
}
}
}
]
}
]
},
"variation": [
{
"type": "tripadvisor",
"series": [
{
"actual_period": "2021-01-01",
"comparison_period": "2020-11-01",
"value": {
"sentiment": {
"value": 0.72,
"variation": "POSITIVE"
},
"contents": {
"positive": {
"value": 1312,
"variation": "POSITIVE"
},
"negative": {
"value": -1,
"variation": "POSITIVE"
},
"neutral": {
"value": 0,
"variation": "NEUTRAL"
},
"total": {
"value": 1311,
"variation": "POSITIVE"
}
},
"poi": {
"partition": {
"value": 3.29,
"variation": "POSITIVE"
},
"count": {
"value": 0,
"variation": "NEUTRAL"
}
}
}
},
{
"actual_period": "2021-02-01",
"comparison_period": "2020-12-01",
"value": {
"sentiment": {
"value": 0.52,
"variation": "POSITIVE"
},
"contents": {
"positive": {
"value": 3342,
"variation": "POSITIVE"
},
"negative": {
"value": 155,
"variation": "NEGATIVE"
},
"neutral": {
"value": 0,
"variation": "NEUTRAL"
},
"total": {
"value": 3497,
"variation": "POSITIVE"
}
},
"poi": {
"partition": {
"value": -4.12,
"variation": "NEGATIVE"
},
"count": {
"value": 756,
"variation": "POSITIVE"
}
}
}
}
]
},
{
"type": "facebook",
"series": [
{
"actual_period": "2021-01-01",
"comparison_period": "2020-11-01",
"value": {
"sentiment": {
"value": -9.34,
"variation": "NEGATIVE"
},
"contents": {
"positive": {
"value": 276,
"variation": "POSITIVE"
},
"negative": {
"value": 229,
"variation": "NEGATIVE"
},
"neutral": {
"value": 984,
"variation": "POSITIVE"
},
"total": {
"value": 1489,
"variation": "POSITIVE"
}
},
"poi": {
"partition": {
"value": 3.27,
"variation": "POSITIVE"
},
"count": {
"value": 156,
"variation": "POSITIVE"
}
}
}
},
{
"actual_period": "2021-02-01",
"comparison_period": "2020-12-01",
"value": {
"sentiment": {
"value": 4.85,
"variation": "POSITIVE"
},
"contents": {
"positive": {
"value": -69,
"variation": "NEGATIVE"
},
"negative": {
"value": -100,
"variation": "POSITIVE"
},
"neutral": {
"value": -261,
"variation": "NEGATIVE"
},
"total": {
"value": -430,
"variation": "NEGATIVE"
}
},
"poi": {
"partition": {
"value": -3.13,
"variation": "NEGATIVE"
},
"count": {
"value": 24,
"variation": "POSITIVE"
}
}
}
}
]
}
]
},
"paging": {
"last": "/overall/series/grouped/compare?page=9&page_size=2&period=month&geometry_id=379c730942e570d586a5520770c0a65d&compare_from=2020-11-01&from=2021-01-01&group_type=network&to=2021-02-28&compare_to=2020-12-31",
"first": "/overall/series/grouped/compare?page=1&page_size=2&period=month&geometry_id=379c730942e570d586a5520770c0a65d&compare_from=2020-11-01&from=2021-01-01&group_type=network&to=2021-02-28&compare_to=2020-12-31",
"prev": null,
"next": "/overall/series/grouped/compare?page=2&page_size=2&period=month&geometry_id=379c730942e570d586a5520770c0a65d&compare_from=2020-11-01&from=2021-01-01&group_type=network&to=2021-02-28&compare_to=2020-12-31",
"current": "/overall/series/grouped/compare?page=1&page_size=2&period=month&geometry_id=379c730942e570d586a5520770c0a65d&compare_from=2020-11-01&from=2021-01-01&group_type=network&to=2021-02-28&compare_to=2020-12-31",
"pages": [
{
"number": 1,
"uri": "/overall/series/grouped/compare?page=1&page_size=2&period=month&geometry_id=379c730942e570d586a5520770c0a65d&compare_from=2020-11-01&from=2021-01-01&group_type=network&to=2021-02-28&compare_to=2020-12-31"
},
{
"number": 2,
"uri": "/overall/series/grouped/compare?page=2&page_size=2&period=month&geometry_id=379c730942e570d586a5520770c0a65d&compare_from=2020-11-01&from=2021-01-01&group_type=network&to=2021-02-28&compare_to=2020-12-31"
},
{
"number": 3,
"uri": "/overall/series/grouped/compare?page=3&page_size=2&period=month&geometry_id=379c730942e570d586a5520770c0a65d&compare_from=2020-11-01&from=2021-01-01&group_type=network&to=2021-02-28&compare_to=2020-12-31"
},
{
"number": 4,
"uri": "/overall/series/grouped/compare?page=4&page_size=2&period=month&geometry_id=379c730942e570d586a5520770c0a65d&compare_from=2020-11-01&from=2021-01-01&group_type=network&to=2021-02-28&compare_to=2020-12-31"
},
{
"number": 5,
"uri": "/overall/series/grouped/compare?page=5&page_size=2&period=month&geometry_id=379c730942e570d586a5520770c0a65d&compare_from=2020-11-01&from=2021-01-01&group_type=network&to=2021-02-28&compare_to=2020-12-31"
}
],
"elements": [
1,
2
],
"total": 17,
"size": 2
}
}