Account dashboard

Account-side dashboard widget endpoints.

Account-side dashboard widget endpoints. All GETs. Common query envelope: store_id (optional, scoped by an ownership check), review_site_id (optional), range_start / range_end (optional YYYY-MM-DD). Auth: authentication bearer. Powers the account-admin home page tiles + charts.

Prerequisites

  • A bearer token in the Authorization header. 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

StatusMeaning
401The bearer token is missing, expired or invalid
403The token is valid but the record sits outside your account
422The request failed validation — the response names the fields
500Unexpected server error

Individual endpoints may return more; each page lists its own.

Endpoints

MethodEndpointDescription
GETGet KPI data countsTop-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.
GETGet average-rating chartAverage-rating line chart for the account dashboard: a cumulative (running) average rating per time bucket across the window.
GETGet total-review chartTotal-reviews line chart for the account dashboard: a cumulative (running) count of reviews per time bucket across the window.
GETGet total-response chartTotal-responses line chart for the account dashboard: a cumulative (running) count of reviews that have a response, per time bucket across the window.
GETGet response-time chartResponse-time line chart for the account dashboard: a cumulative (running) average response time in DAYS per time bucket across the window.
GETGet review-request chartReview-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.
GETGet review-rating breakdownStar-rating breakdown for the account dashboard: total qualifying review counts grouped by star rating (1–5).
GETGet review-site distributionReview-site distribution for the account dashboard: review counts and average ratings per platform.
GETGet sentiment overviewSentiment overview for the account dashboard: positive (4–5 star), neutral (3 star), and negative (1–2 star) review counts.
GETGet annual volume + rating statsAnnual 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.
GETGet top-performing locationsTop-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.
GETGet monthly ranking reportMonthly 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.
GETGet overall ranking by location (last 12 months)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 hipages stores).