Skip to main content

Aggregate rating details object definition and links to validations

Properties

ParentNameTypeInput
$.aggregateRatingDetailsobject
REQUIRED
aggregateRatingDetailsstarRatings[]array
REQUIRED
aggregateRatingDetailstypestring
REQUIRED
aggregateRatingDetailspricingobject
OPTIONAL

JSON Data Samples

Aggregate Rating Satisfying Minimal Data Requirements
{
"aggregateRatingDetails": {
"starRatings": [
{
"category": "OVERALL",
"bestRating": 5,
"worstRating": 1,
"ratingValue": 4,
"ratingCount": 504,
"reviewCount": 249
}
],
"type": "USER"
}
}
Aggregate Rating - Full Example
{
"aggregateRatingDetails": {
"starRatings": [
{
"category": "OVERALL",
"bestRating": 5,
"worstRating": 1,
"ratingValue": 4,
"ratingCount": 504,
"reviewCount": 249,
"distribution": [
{ "key": "1", "value": 7},
{ "key": "2", "value": 19},
{ "key": "3", "value": 25},
{ "key": "4", "value": 358},
{ "key": "5", "value": 95}
]
}
],
"pricing": {
"indicator": 4
},
"type": "USER"
}
}
NameReference
APILink