GroupedComparedOverallResults
| Field | Description | Type |
|---|---|---|
| actual | Overall grouped data for the requested timeframe. | GroupedComparableOverall |
| comparison | Overall grouped data for the self-calculated past timeframe. | GroupedComparableOverall |
| variation | Calculated difference between actual and comparison. |
array[GroupedOverallVariation] |
GroupedComparableOverall
| Field | Description | Type |
|---|---|---|
| value | Overall grouped data for the corresponding timeframe. |
array[GroupedOverallElement] |
| timeframe | Reference date range. | Timeframe |
GroupedOverallElement
| Field | Description | Type |
|---|---|---|
| *group | Field value within the requested grouping by field. | string |
| *overall | Overall data of corresponding group. |
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 |
GroupedOverallVariation
| Field | Description | Type |
|---|---|---|
| *group | Field value within the requested grouping by field. | string |
| *compare | Overall variation data of corresponding group. |
OverallVariation |
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 |