Get top-performing locations

Overview

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

Prerequisites

• A bearer token. Callable with Account tokens.

Base URL

Endpoint

GET /api/v1/account/dashboard/get-top-performing-locations

Authentication

• Requires a bearer token in the Authorization: Bearer <bearer-token> header.

• Who can call it: Account tokens.

• Mounted 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.

Query parameters

• 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.

Response

• store_id (integer) — store PK.
• store_name (string) — "<store name> - <storeid>".
• reviews (integer) — total reviews (hipages spans all connected sites).
• rating (number/float) — average rating (hipages spans all connected sites).

200 Success · 200

{
  "data": [
    { "store_id": 42, "store_name": "Downtown - LOC-001", "reviews": 312, "rating": 4.78 },
    { "store_id": 87, "store_name": "Northside - LOC-007", "reviews": 248, "rating": 4.65 },
    { "store_id": 124, "store_name": "Westview - LOC-012", "reviews": 198, "rating": 4.61 }
  ]
}

Errors

Example request

curl --request GET \
  --url "https://production-api.shoutaboutus.com/api/v1/account/dashboard/get-top-performing-locations?range_start=2026-01-01&range_end=2026-01-31" \
  --header 'Authorization: Bearer <bearer-token>' \
  --header 'Accept: application/json'