Get review-rating breakdown

Overview

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.

Prerequisites

• A bearer token. Callable with Account tokens.

Base URL

Endpoint

GET /api/v1/account/dashboard/get-review-rating-breakdown

Authentication

• Requires a bearer token in the Authorization: Bearer <bearer-token> header.

• Who can call it: Account tokens.

• Mounted under the account/dashboard group (role-agnostic).

• Scope is the caller's company tree.

• store_id (if given) is validated by an ownership check; otherwise all of the caller's stores are used.

Rate limit

• No rate limit.

Query parameters

• 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

200 Success · 200

{
  "data": {
    "1 Star": 18,
    "2 Star": 42,
    "3 Star": 87,
    "4 Star": 312,
    "5 Star": 789
  }
}

Errors

Example request

curl --request GET \
  --url "https://production-api.shoutaboutus.com/api/v1/account/dashboard/get-review-rating-breakdown?store_id=123&review_site_id=123&range_start=2026-01-01&range_end=2026-01-31" \
  --header 'Authorization: Bearer <bearer-token>' \
  --header 'Accept: application/json'