The individual charts and counts that make up a business's dashboard.
The individual charts and counts that make up a business's dashboard.
Prerequisites
- A bearer token in the
Authorizationheader. Any endpoint that needs no token says so on its own page. - The id of each record the call targets. Every endpoint page lists the ids it needs.
Errors
| Status | Meaning |
|---|---|
401 | The bearer token is missing, expired or invalid |
403 | The token is valid but the record sits outside your account |
422 | The request failed validation — the response names the fields |
500 | Unexpected server error |
Individual endpoints may return more; each page lists its own.
Endpoints
| Method | Endpoint | Description |
|---|---|---|
GET | Headline counts | Top-row KPI tiles for the account dashboard: total reviews, average rating (bridge-aware), campaign request count, response-rate %, average response time (days), and reviews awaiting a response. |
GET | Average rating over time | Average-rating line chart for the account dashboard: a cumulative (running) average rating per time bucket across the window. |
GET | Reviews over time | Total-reviews line chart for the account dashboard: a cumulative (running) count of reviews per time bucket across the window. |
GET | Responses over time | Total-responses line chart for the account dashboard: a cumulative (running) count of reviews that have a response, per time bucket across the window. |
GET | Response time over time | Response-time line chart for the account dashboard: a cumulative (running) average response time in DAYS per time bucket across the window. |
GET | Review requests over time | Review-requests line chart for the account dashboard: a cumulative (running) count of sent review requests (email + SMS campaign requests combined) per time bucket across the window, bucketed by the request's sent_at. |
GET | Rating breakdown | Star-rating breakdown for the account dashboard: total qualifying review counts grouped by star rating (1–5). |
GET | Reviews by site | Review-site distribution for the account dashboard: review counts and average ratings per platform. |
GET | Sentiment | Sentiment overview for the account dashboard: positive (4–5 star), neutral (3 star), and negative (1–2 star) review counts. |
GET | This year versus last | 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. |
GET | Top locations | Top-performing locations for the account dashboard: the top 3 store locations under the caller's account ranked by total (bridge-aware) review count, each with its average rating. |
GET | Monthly ranking | Monthly average-rating ranking report for the account dashboard: the last 4 calendar months' bridge-aware average ratings, broken out per year across roughly the last 3+ years (start of ~3y4m ago through end of this month), grouped by year. |
GET | Twelve-month ranking | Overall location ranking for the selected window (default last 12 months): up to 10 store locations ranked and graded by review count, response rate, and average rating (bridge-aware for partner-specific stores). |