Get total-response chart

Overview

Total-responses line chart for the account dashboard. It shows a cumulative (running) response-rate percentage (responded ÷ total, ×100) per time bucket across the window, bucketed by review date. Bucket granularity is auto-selected from the range span (daily ≤30d / weekly ≤180d / monthly ≤730d / else yearly) with the timeline gap-filled. Responses are bucketed by the response's creation date.

Prerequisites

• A bearer token. Callable with Account tokens.

Base URL

Endpoint

GET /api/v1/account/dashboard/get-totalresponse-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. No industry-based default is applied on this endpoint when it is omitted.
• 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.
• count (number) — cumulative response-rate percentage up to and including this bucket.

200 Success · 200

{
  "data": [
    { "period": "2026-03", "count": 62.5 },
    { "period": "2026-04", "count": 68.0 },
    { "period": "2026-05", "count": 71.2 }
  ]
}

Errors

Example request

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