Lifetime reviews by site

Get all-time review totals by site, not limited to a period. Each row also has the review count and rating for the date range you send. Use this for a big-picture view. Returns totals per site.

Prerequisites: a Partner bearer token and a date range (range_start, range_end, both Y-m-d H:i:s). Optional: a store_id or account_id to narrow the report.

Authentication: Partner token. It covers every location under your partner, or one account or location when you send account_id or store_id; every id must be inside your tree, otherwise 422.

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 date range, as Y-m-d H:i:s.

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

End of the date range, as Y-m-d H:i:s.

integer
Defaults to 3007

One location to report on. Must exist and be inside your tree.

integer
Defaults to 5994

One account under your partner (an account id, not a location). Must exist and be inside your tree.

string
length ≤ 255
Defaults to LOC-001

Checked (max 255 characters, must be inside your tree) but not used by this endpoint. Send store_id instead.

string
length ≤ 255
Defaults to ACC-001

Checked (max 255 characters, must be inside your tree) but not used by this endpoint. Send account_id instead.

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