▪ Overall Series Compare
Overall Series Compare API returns two, time-based overall data series at once: one defined by the specified {Location} and [from,to] query parameters and another defined by compare_ prefixed query parameters (or auto-calculated with default values where specified).
Additional comparative time-based data series between the two data series are returned as well.
Request
Endpoint
GET
/v4/{billing_plan}/account/{account_id}/locations/overall/series/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 | |
| {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 |
Supported values for period
- week
- month
Example
curl -X GET 'https://api.datappeal.io/v4/ondemand/account/{account_id}/locations/overall/series/compare?geometry_id=379c730942e570d586a5520770c0a65d&from=2021-01-01&to=2021-02-28&compare_from=2020-11-01&compare_to=2020-12-31&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/compare?geometry_id=379c730942e570d586a5520770c0a65d&from=2021-01-01&to=2021-02-28&compare_from=2020-11-01&compare_to=2020-12-31&period=month' \
-H 'x-api-key: {x_api_key}' \
-H 'Authorization: Bearer {jwt_bearer}' \
Response
Status
| Status | Description |
|---|---|
| 200 | Overall Series Compare data has been successfully returned. |
Body
LocationComparedSeriesOverall
| Field | Description | Type |
|---|---|---|
| actual | Overall data for the actual timeframe. | LocationComparableSeriesOverall |
| comparison | Overall data for the comparison timeframe. | LocationComparableSeriesOverall |
| variation | Calculated difference between actual and comparison. |
LocationSeriesOverallVariation |
LocationComparableSeriesOverall
| Field | Description | Type |
|---|---|---|
| timeframe | Reference date range. | Timeframe |
| value | Overall data series for the corresponding timeframe. |
LocationSeriesOverall |
Timeframe
| Field | Description | Type |
|---|---|---|
| *from | Start date of timeframe. | date |
| *to | End date of timeframe. | date |
LocationSeriesOverall
| Field | Description | Type |
|---|---|---|
| series | Overall series data for the requested timeframe and period. | 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 |
LocationSeriesOverallVariation
| Field | Description | Type |
|---|---|---|
| series | Overall data 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 |
Value of $.actual,comparison.value.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
{
"actual": {
"timeframe": {
"from": "2021-01-01",
"to": "2021-02-28"
},
"value": {
"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
}
}
}
]
}
},
"comparison": {
"timeframe": {
"from": "2020-11-01",
"to": "2020-12-31"
},
"value": {
"series": [
{
"period": "2020-11-01",
"value": {
"sentiment": {
"value": 88.49,
"polarity": "POSITIVE"
},
"contents": {
"positive": 15752,
"negative": 1280,
"neutral": 467,
"total": 17499
},
"poi": {
"partition": 100.0,
"count": 4842
}
}
},
{
"period": "2020-12-01",
"value": {
"sentiment": {
"value": 87.65,
"polarity": "POSITIVE"
},
"contents": {
"positive": 10876,
"negative": 1046,
"neutral": 778,
"total": 12700
},
"poi": {
"partition": 100.0,
"count": 3886
}
}
}
]
}
},
"variation": {
"series": [
{
"actual_period": "2021-01-01",
"comparison_period": "2020-11-01",
"value": {
"sentiment": {
"value": -0.43,
"variation": "NEGATIVE"
},
"contents": {
"positive": {
"value": -181,
"variation": "NEGATIVE"
},
"negative": {
"value": 143,
"variation": "NEGATIVE"
},
"neutral": {
"value": 981,
"variation": "POSITIVE"
},
"total": {
"value": 943,
"variation": "POSITIVE"
}
},
"poi": {
"partition": {
"value": 0.0,
"variation": "NEUTRAL"
},
"count": {
"value": -196,
"variation": "NEGATIVE"
}
}
}
},
{
"actual_period": "2021-02-01",
"comparison_period": "2020-12-01",
"value": {
"sentiment": {
"value": 1.22,
"variation": "POSITIVE"
},
"contents": {
"positive": {
"value": 5154,
"variation": "POSITIVE"
},
"negative": {
"value": 212,
"variation": "NEGATIVE"
},
"neutral": {
"value": -264,
"variation": "NEGATIVE"
},
"total": {
"value": 5102,
"variation": "POSITIVE"
}
},
"poi": {
"partition": {
"value": 0.0,
"variation": "NEUTRAL"
},
"count": {
"value": 1026,
"variation": "POSITIVE"
}
}
}
}
]
}
}