Headline numbers

Get the period's totals for the account: reviews, rating, response rate, response time, reviews awaiting a response, and the sentiment split. Reviews, rating and response rate also come with the previous period's value (*_previous): the window of the same length immediately before range_start.

Prerequisites: a bearer token and a date range (range_start, range_end, both Y-m-d H:i:s). Optional: a location (store_id or client_location_id) or an account (account_id or client_account_id).

Authentication: Partner or Account token. Every id you send must be inside your own account tree, otherwise 422. Without a location or account, the report covers every location the token can see.

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
string
required
Defaults to 2026-01-01 00:00:00

Start of the period, Y-m-d H:i:s (e.g. 2026-01-01 00:00:00). A date without a time is rejected.

string
required
Defaults to 2026-09-30 23:59:59

End of the period, Y-m-d H:i:s (e.g. 2026-09-30 23:59:59).

integer
Defaults to 3007

One location to report on. Must exist and be inside your account tree. Takes priority over every other scope field.

integer
Defaults to 5994

An account to report on (all its locations). Must exist and be inside your account tree. Ignored when store_id or client_location_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.

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.

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