Skip to content

GroupedComparedSeriesRatingsResults

Field Description Type
actual Ratings data series for the actual timeframe. GroupedComparableSeriesRatings
comparison Ratings data series for the comparison timeframe. GroupedComparableSeriesRatings
variation Calculated difference between actual and comparison. array[SeriesGroupedRatingsVariation]
GroupedComparableSeriesRatings
Field Description Type
timeframe Reference date range. Timeframe
value Rating grouped data series for the corresponding timeframe. array[GroupedSeriesRatingsElement]
Timeframe
Field Description Type
*from Start date of timeframe. date
*to End date of timeframe. date
GroupedSeriesRatingsElement
Field Description Type
*group Field value within the requested grouping by field. string
*series Rating data series of corresponding group. array[SeriesRatingsElement]
SeriesRatingsElement
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 Ratings data of corresponding period. Ratings
Ratings
Field Description Type
contents Total count of contents. Total
rating Average rating score. AverageCap
Total
Field Description Type
total Total count of elements. int
AverageCap
Field Description Type
average Average value in the range [0,cap]. decimal
cap Max possible value. int
SeriesGroupedRatingsVariation
Field Description Type
*type Field value within the requested grouping by field. string
*series Rating data variation series for the requested timeframe and period. array[SeriesRatingsVariationElement]
SeriesRatingsVariationElement
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 Rating variation data between actual_period and comparison_period. RatingsVariation
RatingsVariation
Field Description Type
contents Contents variation. Variation
rating Rating 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