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 |