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:
| Field | Type | Required | Notes |
|---|---|---|---|
account_id | integer | required* | 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_id | integer | required* | 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_id | string (max 255) | optional | Partner-supplied external store identifier; resolved to a store_id. Scoped by an ownership check. |
client_account_id | string (max 255) | optional | Partner-supplied external account identifier; resolved to an account_id. Scoped by an ownership check. |
review_site_id | integer | optional | Filters reviews/responses to one review site's id (e.g. Google, Yelp). |
date | string (Y-m-d) | optional | Reference 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 formattedF-Y, e.g."June-2026".data[].reviews(int) — count of qualifying reviews in that month.data[].avg_rating(float) — averagerateof that month's reviews (0 if none).data[].overall_rating(float) — cumulative averagerateof 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.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
