Skip to content

ComparedClustersResults

Field Description Type
actual Clusters grouped data for the requested timeframe. ComparableClusters
comparison Clusters grouped data for the self-calculated past timeframe. ComparableClusters
variation Calculated difference between actual and comparison. array[ClusterVariationElement]
ComparableClusters
Field Description Type
value Clusters data for the corresponding timeframe. array[Cluster]
timeframe Reference date range. Timeframe
Cluster
Field Description Type
:fontawesome-solid-exclamation-circle: name Descriptive identifier of the cluster. string
contents Total and grouped by polarity count of contents. PolarizedCount
opinions Total and grouped by polarity count of opinions. PolarizedCount
sentiment KPI which indicates users global satisfaction. PolarizedValue
:fontawesome-solid-sync-alt: cluster Descriptive identifier of the cluster. string
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
Timeframe
Field Description Type
*from Start date of timeframe. date
*to End date of timeframe. date
ClusterVariationElement
Field Description Type
*name Descriptive identifier of the cluster. string
*compare Cluster variation data. FullVariation
FullVariation
Field Description Type
sentiment Sentiment variation. Variation
contents Grouped by polarity contents variation. PolarizedVariation
opinions Grouped by polarity opinions variation. 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
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