GroupedComparedRatingsResults
| Field | Description | Type |
|---|---|---|
| actual | Ratings grouped data for the requested timeframe. | GroupedComparableRatings |
| comparison | Ratings grouped data for the self-calculated past timeframe. | GroupedComparableRatings |
| variation | Calculated difference between actual and comparison. |
array[GroupedRatingsVariation] |
GroupedComparableRatings
| Field | Description | Type |
|---|---|---|
| value | Rating grouped data for the corresponding timeframe. |
array[GroupedRatingsElement] |
| timeframe | Reference date range. | Timeframe |
GroupedRatingsElement
| Field | Description | Type |
|---|---|---|
| *group | Field value within the requested grouping by field. | string |
| *rating | Ratings data of corresponding group. |
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 |
Timeframe
| Field | Description | Type |
|---|---|---|
| *from | Start date of timeframe. | date |
| *to | End date of timeframe. | date |
GroupedRatingsVariation
| Field | Description | Type |
|---|---|---|
| *group | Field value within the requested grouping by field. | string |
| *compare | Ratings variation data of corresponding group. |
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 |