get
https://production-api.shoutaboutus.com/api/v1/account/dashboard/get-annual-volume-rating-stats
Annual volume + rating stats for the account dashboard: the last 13 months (fixed window — start of 13 months ago through end of last month) of per-month review counts, response counts, monthly average rating, and a single all-history overall rating. Rating math is bridge-aware for hipages stores.
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. Passing9automatically expands to[9, 44]. - NOTE: the date window is fixed server-side (last 13 months) —
range_start/range_endare NOT read by this endpoint.
Response — { data: [.] } envelope; an array of 13 month rows in chronological order.
month(string) —"Mon YYYY"(e.g.May 2025).reviews(integer) — review count that month (bridge-unified for hipages).responses(integer) — response count that month.monthly_avg_rating(number) — that month's average rating, rounded to 2 decimals.overall_rating(number) — all-history overall rating before the window, rounded to 2 decimals (same value on every row).
Errors: 422 on validation failure.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
