Annual volume + rating chart (account-only)

Returns the last 12 months (relative to date) of per-month review volume, average rating, cumulative overall rating, and response counts for an account or a single store — used to drive the annual volume + rating chart.

Auth: Both — authentication (mounted under the top-level api. group, not a partner/* prefix). Every identifier param runs through an ownership check, which resolves the target to a company id and rejects anything outside the caller's tree. An account caller (bundle_id=3) passes its own account_id/store_id or its own client_account_id/client_location_id. A partner caller (bundle_id=1) may pass any account/store under its child tree, and external client ids are resolved against the partner's full descendant set. account_id must reference a bundle_id=3 (account) company row.

Rate limit: No rate limit.

Request

  • Body:
FieldTypeRequiredNotes
account_idintegerrequired*A the account's id with bundle_id=3 (an account). Required unless supply one of store_id / client_location_id / client_account_id. Must belong to the caller's hierarchy. Expands to all child store ids.
store_idintegerrequired*A single the location's id. Required unless supply one of account_id / client_location_id / client_account_id. Must belong to the caller's hierarchy.
client_location_idstring (max 255)optionalPartner-supplied external store identifier; resolved to a store_id. Scoped by an ownership check.
client_account_idstring (max 255)optionalPartner-supplied external account identifier; resolved to an account_id. Scoped by an ownership check.
review_site_idintegeroptionalFilters reviews/responses to one review site's id (e.g. Google, Yelp).
datestring (Y-m-d)optionalReference date; the 12-month window ends at this month. Defaults to today.

*At least one of account_id, store_id, client_location_id, client_account_id is required (required_without_all).

Response{ data. } envelope. The payload is { status, data } where data is a 12-element array (oldest month first), one entry per month:

  • status (string) — always "success".
  • data[].month (string) — month label formatted F-Y, e.g. "June-2026".
  • data[].reviews (int) — count of qualifying reviews in that month.
  • data[].avg_rating (float) — average rate of that month's reviews (0 if none).
  • data[].overall_rating (float) — cumulative average rate of all qualifying reviews up to and including the end of that month.
  • data[].responses (int) — count of reviews in that month that have a recorded response.

Errors: 422 on validation failure.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
integer
integer
string
Response

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json