LocationComparedSeriesClustersResults
| Field | Description | Type |
|---|---|---|
| actual | Clusters data series for the actual timeframe. | LocationComparableSeriesClusters |
| comparison | Clusters data series for the comparison timeframe. | LocationComparableSeriesClusters |
| variation | Calculated difference between actual and comparison. |
array[LocationSeriesClustersVariation] |
LocationComparableSeriesClusters
| Field | Description | Type |
|---|---|---|
| timeframe | Reference date range. | Timeframe |
| value | Clusters data series for the corresponding timeframe. |
LocationSeriesCluster |
Timeframe
| Field | Description | Type |
|---|---|---|
| *from | Start date of timeframe. | date |
| *to | End date of timeframe. | date |
LocationSeriesCluster
| Field | Description | Type |
|---|---|---|
| *cluster | Descriptive identifier of the cluster. | string |
| *series | Cluster data series. | array[LocationSeriesClusterElement] |
LocationSeriesClusterElement
| 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 | Cluster data of corresponding period. |
LocationSemantics |
LocationSemantics
| Field | Description | Type |
|---|---|---|
| contents | Total count of contents. | Total |
| opinions | Total and grouped by polarity count of opinions. | PolarizedCount |
| sentiment | KPI which indicates users global satisfaction. | PolarizedValue |
Total
| Field | Description | Type |
|---|---|---|
| total | Total count of elements. | int |
PolarizedCount
| Field | Description | Type |
|---|---|---|
| positive | Positive elements count. | int |
| negative | Negative elements count. | int |
| neutral | Neutral elements count. | int |
| total | Total elements count. | int |
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 |
LocationSeriesClustersVariation
| Field | Description | Type |
|---|---|---|
| *cluster | Descriptive identifier of the cluster. | string |
| *series | Cluster data variation series for the requested timeframe and period. | array[LocationSeriesSemanticsVariationElement] |
LocationSeriesSemanticsVariationElement
| 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 | Cluster variation data between actual_period and comparison_period. |
LocationSemanticsVariation |
LocationSemanticsVariation
| Field | Description | Type |
|---|---|---|
| *opinions | Grouped by polarity opinions variation. | PolarizedVariation |
| *contents | Grouped by polarity contents variation. | TotalVariation |
| *sentiment | Sentiment variation. | Variation |
PolarizedVariation
| Field | Description | Type |
|---|---|---|
| positive | Positive elements count variation. | Variation |
| negative | Negative elements count variation. | Variation |
| neutral | Neutral elements count variation. | Variation |
| total | Total elements count variation. | Variation |
TotalVariation
| Field | Description | Type |
|---|---|---|
| total | Total elements count variation. | Variation |
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 |