Annual volume and rating

Get review volume and rating by month over a year: 12 monthly rows, oldest first, ending with the month of date (this month when date is left out).

Prerequisites: a bearer token and an account (account_id or client_account_id) or a location (store_id or client_location_id); at least one is required.

Authentication: Partner or Account token. Every id you send must be inside your own account tree, otherwise 422; account_id must be an account.

Rate limit: 120 requests per minute, counted per user (the token’s user).

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

The account to report on (all its locations). Must be an account inside your tree. Required unless you send store_id, client_location_id or client_account_id.

integer
Defaults to 3007

One location to report on. Must exist and be inside your tree. Required unless you send account_id, client_location_id or client_account_id. Takes priority over account_id.

string
Defaults to docs-test-loc-001

Your own id for the location, instead of store_id. Up to 255 characters. Ignored when store_id is sent.

string
Defaults to ACME-001

Your own id for the account, instead of account_id. Up to 255 characters. Ignored when account_id is sent.

integer
Defaults to 44

Only this review site, e.g. 44 for Google. Must be an existing review site.

date
Defaults to 2025-06-01

Reference date, Y-m-d; the 12 months end with this date's month. Default: today.

Responses

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