▪ 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}/poi/{poi_id}/overall/series/grouped/compare
Path Parameters
| Name | Description | Type | Examples |
|---|---|---|---|
| *{billing_plan} | Billing plan to be applied to the call. | string | licence ondemand |
| *{account_id} | Provided identifier of the account. | string | |
| *{poi_id} | Identifier of the POI to retrieve data for. Value obtainable either : - if {billing_plan}= licence, from $.results[*].resource.id field of List Licences Response Body- if {billing_plan}= ondemand, from $.results.pois[*].id field of any Search API Response Body. |
string | XXeUNbmtYZTsH7UGvNfXWo |
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 |
|---|---|---|---|---|
| *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 | dayweekmonth | |
| *group_type | Field for which perform grouping. | string | networkuser_countrycontent_languageuser_type | |
| reply_received | Filter by contents with a reply. | boolean | truefalse | |
| ⓝ network | Filter by network. | 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 | |
| ⓝ user_type | Filter by user type. | string | Dictionary | |
| 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
- day
- week
- month
Supported values for group_type
- network
- user_country
- content_language
- user_type
Example
curl -X GET 'https://api.datappeal.io/v4/licence/account/{account_id}/poi/HF8xjSQW4W43NGr56denSh/overall/series/grouped/compare?from=2020-01-01&to=2020-02-29&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
GroupedComparedSeriesOverall
| Field | Description | Type |
|---|---|---|
| *results | Paginated grouped compared overall data series. | GroupedComparedSeriesOverallResults |
| paging | Response pagination. | Paging |
GroupedComparedSeriesOverallResults
| Field | Description | Type |
|---|---|---|
| actual | Overall data for the requested timeframe. | GroupedComparableSeriesOverall |
| comparison | Overall data for the self-calculated past timeframe. | GroupedComparableSeriesOverall |
| variation | Calculated difference between actual and comparison. |
array[SeriesGroupedOverallVariation] |
GroupedComparableSeriesOverall
| Field | Description | Type |
|---|---|---|
| value | Overall grouped data series for the corresponding timeframe. |
array[GroupedSeriesOverallElement] |
| timeframe | Reference date range. | Timeframe |
GroupedSeriesOverallElement
| Field | Description | Type |
|---|---|---|
| *group | Field value within the requested grouping by field. | string |
| *series | Overall data series of corresponding group. |
array[SeriesOverallElement] |
SeriesOverallElement
| Field | Description | Type |
|---|---|---|
| *period | Date representing the requested period, corresponding to the first day of the period.day: the day itself.week: first day of the corresponding week.month: first day of the corresponding month. |
date |
| *value | Overall grouped data of corresponding period. |
Overall |
Overall
| Field | Description | Type |
|---|---|---|
| sentiment | KPI which indicates users global satisfaction. | PolarizedValue |
| contents | Total and grouped by polarity count of contents. | PolarizedCount |
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 |
Timeframe
| Field | Description | Type |
|---|---|---|
| *from | Start date of timeframe. | date |
| *to | End date of timeframe. | date |
SeriesGroupedOverallVariation
| Field | Description | Type |
|---|---|---|
| *group | Field value within the requested grouping by field. | string |
| series | Overall data variation series for the requested timeframe and period. | array[SeriesOverallVariationElement] |
SeriesOverallVariationElement
| Field | Description | Type |
|---|---|---|
| *value | Overall variation data between actual_period and previous_period. |
OverallVariation |
| *actual_period | Date representing the actual period, corresponding to the first day of the period.day: the day itself.week: first day of the corresponding week.month: first day of the corresponding month. |
date |
| *previous_period | Date representing the previous period, corresponding to the first day of the period.day: the day itself.week: first day of the corresponding week.month: first day of the corresponding month. |
date |
OverallVariation
| Field | Description | Type |
|---|---|---|
| sentiment | Sentiment variation. | Variation |
| contents | Grouped by polarity variation of contents. | PolarizedVariation |
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": {
"value": [
{
"group": "agoda",
"series": [
{
"period": "2020-01-01",
"value": {
"sentiment": {
"value": null,
"polarity": "NEUTRAL"
},
"contents": {
"positive": 0,
"negative": 0,
"neutral": 0,
"total": 0
}
}
},
{
"period": "2020-02-01",
"value": {
"sentiment": {
"value": 67.00,
"polarity": "POSITIVE"
},
"contents": {
"positive": 1,
"negative": 1,
"neutral": 0,
"total": 2
}
}
}
]
},
{
"group": "booking",
"series": [
{
"period": "2020-01-01",
"value": {
"sentiment": {
"value": 79.65,
"polarity": "POSITIVE"
},
"contents": {
"positive": 189,
"negative": 38,
"neutral": 0,
"total": 227
}
}
},
{
"period": "2020-02-01",
"value": {
"sentiment": {
"value": 78.75,
"polarity": "POSITIVE"
},
"contents": {
"positive": 126,
"negative": 28,
"neutral": 0,
"total": 154
}
}
}
]
}
],
"timeframe": {
"from": "2020-01-01",
"to": "2020-02-29"
}
},
"comparison": {
"value": [
{
"group": "booking",
"series": [
{
"period": "2019-01-01",
"value": {
"sentiment": {
"value": 81.85,
"polarity": "POSITIVE"
},
"contents": {
"positive": 190,
"negative": 33,
"neutral": 0,
"total": 223
}
}
},
{
"period": "2019-02-01",
"value": {
"sentiment": {
"value": 81.35,
"polarity": "POSITIVE"
},
"contents": {
"positive": 164,
"negative": 28,
"neutral": 0,
"total": 192
}
}
}
]
}
],
"timeframe": {
"from": "2019-01-01",
"to": "2019-02-28"
}
},
"variation": [
{
"group": "booking",
"series": [
{
"value": {
"sentiment": {
"value": -2.20,
"variation": "NEGATIVE"
},
"contents": {
"positive": {
"value": -1,
"variation": "NEGATIVE"
},
"negative": {
"value": 5,
"variation": "NEGATIVE"
},
"neutral": {
"value": 0,
"variation": "NEUTRAL"
},
"total": {
"value": 4,
"variation": "POSITIVE"
}
}
},
"actual_period": "2020-01-01",
"previous_period": "2019-01-01"
},
{
"value": {
"sentiment": {
"value": -2.60,
"variation": "NEGATIVE"
},
"contents": {
"positive": {
"value": -38,
"variation": "NEGATIVE"
},
"negative": {
"value": 0,
"variation": "NEUTRAL"
},
"neutral": {
"value": 0,
"variation": "NEUTRAL"
},
"total": {
"value": -38,
"variation": "NEGATIVE"
}
}
},
"actual_period": "2020-02-01",
"previous_period": "2019-02-01"
}
]
}
]
},
"paging": {
"last": "overall/series/grouped/compare?page=3&page_size=2&period=month&from=2020-01-01&group_type=network&to=2020-02-29",
"first": "overall/series/grouped/compare?page=1&page_size=2&period=month&from=2020-01-01&group_type=network&to=2020-02-29",
"prev": null,
"next": "overall/series/grouped/compare?page=2&page_size=2&period=month&from=2020-01-01&group_type=network&to=2020-02-29",
"current": "overall/series/grouped/compare?page=1&page_size=2&period=month&from=2020-01-01&group_type=network&to=2020-02-29",
"pages": [
{
"number": 1,
"uri": "overall/series/grouped/compare?page=1&page_size=2&period=month&from=2020-01-01&group_type=network&to=2020-02-29"
},
{
"number": 2,
"uri": "overall/series/grouped/compare?page=2&page_size=2&period=month&from=2020-01-01&group_type=network&to=2020-02-29"
},
{
"number": 3,
"uri": "overall/series/grouped/compare?page=3&page_size=2&period=month&from=2020-01-01&group_type=network&to=2020-02-29"
}
],
"elements": [
1,
2
],
"total": 6,
"size": 2
}
}