get
https://production-api.shoutaboutus.com/api/v1/account/dashboard/get-averagerating-chart
Average-rating line chart for the account dashboard: a cumulative (running) average rating per time bucket across the window. Bucket granularity is chosen automatically from the range span — daily (≤30d), weekly (≤180d), monthly (≤730d), else yearly — and the timeline is gap-filled so every bucket appears. 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. When omitted, the caller company's industry review sites apply. - Query:
range_start(stringY-m-d, optional) — defaults to start of 13 months ago. - Query:
range_end(stringY-m-d, optional) — must be ≥range_start; defaults to end of current month.
Response — { data: [.] } envelope; an array of buckets in chronological order.
period(string) — bucket key (e.g.2025-05monthly,2025-05-01daily,2025yearly).count(number) — cumulative average rating up to and including this bucket, rounded to 2 decimals (namedcountdespite being a rating value).
Errors: 422 on validation failure.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
