Get review-rating breakdown

Star-rating breakdown for the account dashboard: total qualifying review counts grouped by star rating (1–5). Only rating-eligible reviews are counted (the qualifyingForRatings scope drops hipages legacy, off-platform, and non-qualified rows), so star buckets reflect rating-eligible reviews only.

Auth: Account — authentication, under the account/dashboard group (role-agnostic). Scope is the caller's company tree: store_id (if given) validated by an ownership check; otherwise all of the caller's stores.

Rate limit: No rate limit.

Request

  • Query: store_id (integer, optional) — must belong to the caller's company; omit it to cover all of your locations.
  • Query: review_site_id (integer, optional) — filter to one platform; must be an existing review site.
  • Query: range_start (string Y-m-d, optional) — both range params must be present for the date filter to apply.
  • Query: range_end (string Y-m-d, optional) — must be ≥ range_start.

Response{ data: {.} } envelope; an object keyed by star label "<n> Star" → review count. Only star ratings that have at least one review appear (no zero-fill); empty object when there are none.

Errors: 422 on validation failure.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
string
string
string
Response

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json