Overall location ranking for the selected window (default last 12 months): up to 10 store locations ranked and graded by review count, response rate, and average rating (bridge-aware for hipages stores). Identical to the primary last-12-months ranking page — the only difference is this variant passes range_start/range_end as full Y-m-d H:i:s datetimes, which is exactly what the endpoint requires.
Auth: Account — authentication, under the account/dashboard group (role-agnostic; no partner-only access). Scope is the authenticated user's own company tree: when you supply store_id it must sit inside your own account tree. Otherwise all stores under the user (which itself honours the user's assign_location/assign_brand restrictions).
Rate limit: No rate limit.
Request
- Query:
store_id(integer, optional) — must exist and belong to the caller's company; omit it to cover all of your locations. - Query:
review_site_id(integer, optional) — filter to one platform (e.g.5); must be an existing review site. - Query:
range_start(stringY-m-d H:i:s, optional) — defaults to start of 13 months ago. NOTE: this endpoint requires the full datetime formatY-m-d H:i:s(unlike most other dashboard endpoints which useY-m-d). - Query:
range_end(stringY-m-d H:i:s, optional) — must be ≥range_start; defaults to end of last month.
Response — { data: [.] } envelope; an array of up to 10 ranked locations (empty array when no qualifying reviews).
id(string) —loc_<store id>.final_grade(string) — overall letter grade (e.g.A+,N/A).name(string) —"<store name> - <storeid>".avgRating(string) — average rating formatted to 2 decimals (e.g."0.00").review_count(integer) — qualifying review count (bridge-unified for hipages stores).response_count(string) —"<count> (<percent>%)".
Errors: 422 on validation failure.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
