Ranking report (full payload)

Ranks the authenticated account's locations against each other over a date range — by review volume, average rating, and response rate — and computes a blended overall rank with a letter grade.

Auth: Both — authentication (Passport bearer). Inside rankingReport the caller's company bundle_id must be 3 (account) or 2 (location-account); any other role gets a 403. Walking UP resolves the account name. Store scope comes from unless you supply store_id. Per-role difference: reachable stores differ — a location-level user (bundle_id=2 / assign_location) sees only its assigned store(s), while an account-level user sees every store under the account's location-account children. The optional store_id must sit inside your own account tree, so it must resolve to a store inside the caller's own hierarchy.

Rate limit: No rate limit.

Request

  • Body (all in JSON body):
FieldTypeRequiredNotes
range_startstringyesDate-time, format Y-m-d H:i:s (e.g. 2024-01-01 00:00:00).
range_endstringyesDate-time, format Y-m-d H:i:s.
store_idintegernoNullable. Must Must be an existing location AND pass an ownership check (must belong to the caller's company tree). When omitted, all of the caller's reachable stores are ranked.

Response{ data. } envelope.

  • account_name (string) — the parent account company name (null if no account resolved).
  • interval (object) — start and end, echoed verbatim from the request.
  • locationRank (object) — four arrays of per-location rows:
  • byReview (array) — locations ranked by review_count; each row: id, name, review_count, response_count, response_percent, avgRating, rank.
  • byRate (array) — same row shape, ranked by avgRating.
  • byResponse (array) — same row shape, ranked by response_percent.
  • overAll (array) — each row adds reviewRank, rateRank, responseRank, totalRank (sum of the three), final_grade (A+/A/B/C/D), final_grade_point. When there are 10+ distinct total ranks, a percentage_rank band (e.g. Top 10%) is also added.
  • When no locations have data, all four arrays are empty.

Errors: 422 on validation failure.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
string
integer
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