Get top-performing locations

Top-performing locations for the account dashboard: the top 3 store locations under the caller's account ranked by total (bridge-aware) review count, each with its average rating. Stores with zero reviews are dropped.

Auth: Account — authentication, under the account/dashboard group (role-agnostic). Scope is the caller's own account company (candidate stores = stores whose location-account's parent account = user.person.company.id); assign_location users reach only their assigned stores.

Rate limit: No rate limit.

Request

  • Query: range_start (string Y-m-d, optional) — start of window (no default; null = all-time).
  • Query: range_end (string Y-m-d, optional) — must be ≥ range_start.
  • NOTE: The shared form request accepts store_id and review_site_id and may be sent in the URL, but this endpoint does NOT use them — it always ranks across the caller's whole account tree.

Response{ data: [.] } envelope; an array of up to 3 stores ordered by review count desc.

  • store_id (integer) — store PK.
  • store_name (string) — "<store name> - <storeid>".
  • reviews (integer) — total reviews (bridge-aware).
  • rating (number/float) — average rating (bridge-aware).

Errors: 422 on validation failure.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
string
string
string
Response

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