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