Ranking report

Get the account's locations ranked against each other on rating, volume, and response: one ranking each by review count, rating and response rate, and an overall ranking with a grade. Use this for an internal leaderboard.

Prerequisites: a bearer token and a date range (range_start, range_end, both Y-m-d H:i:s). Optional: a location id (store_id).

Authentication: Partner or Account token (partner, account and location users; others get 403). Without store_id, every location the token can see is ranked; store_id must be inside your own account 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 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

Rank only this location. Must exist and be inside your account tree. Leave it out to rank every location your token can see.

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