Get average-rating chart

Overview

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 spans all connected sites for hipages stores.

Prerequisites

• A bearer token. Callable with Account tokens.

Base URL

Endpoint

GET /api/v1/account/dashboard/get-averagerating-chart

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. When omitted, the caller company's industry review sites apply.
• Query: range_start (string Y-m-d, optional) — defaults to start of 13 months ago.
• Query: range_end (string Y-m-d, optional) — must be ≥ range_start; defaults to end of current month.

Response

• period (string) — bucket key (e.g. 2025-05 monthly, 2025-05-01 daily, 2025 yearly).
• count (number) — cumulative average rating up to and including this bucket, rounded to 2 decimals (named count despite being a rating value).

200 Success · 200

{
  "data": [
    { "period": "2026-03", "count": 4.21 },
    { "period": "2026-04", "count": 4.32 },
    { "period": "2026-05", "count": 4.4 }
  ]
}

Errors

Example request

curl --request GET \
  --url "https://production-api.shoutaboutus.com/api/v1/account/dashboard/get-averagerating-chart?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'