Get total review count plus a per-star breakdown for a single store, plus a canonical average rating and an off-platform review count. Built for hipages consumption.
Auth: Both — authentication (under the reviews group; no partner-only access on this specific route). The target store: a location-assigned user resolves via user_stores, an account user (assign_brand) via assignBrands, and a partner user via the full getStoreListByCompany tree walk. If the requested store_id is not in the caller's accessible set, returns 403 (Store is outside your access scope.). What differs per role: only the reachable store_id set — the response shape is identical.
Rate limit: No rate limit.
Request
- Query:
store_id(integer, required) — the store to report on. - Query:
review_site_id(integer, optional) — filter to a single review site (e.g. 44); also drives the per-site average viaRatingBridge.
Suppressed (suppressed_at) and soft-deleted reviews are excluded from all counts. The endpoint excludes off-platform reviews from total_reviews/star_breakdown and reported separately. Legacy reviews (is_legacy) count toward total_reviews but contribute 0 to per-star buckets.
Response — { data. } envelope.
total_reviews(int) — rating-eligible (non off-platform, non-suppressed) review count.star_breakdown(object) — keys"1"."5", each (int) the count of non-legacy reviews at that star value.average_rating(number|null) — canonical average;nullwhen nothing is rating-eligible.off_platform_count(int) — off-platform (is_off_platform=true) reviews for the store, reported separately.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
