Headline numbers

Get the totals for the period: reviews collected, response rate, average rating, average response time, and reviews awaiting a response, each with the figure for the previous period. Use this for a dashboard header.

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

Your own id for a location. When sent, it's used instead of store_id. Max 255 characters; must be inside your tree.

string
length ≤ 255
Defaults to ACC-001

Your own id for an account. When sent, it's used instead of account_id. Max 255 characters; must be inside your tree.

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