Get monthly ranking report

Monthly average-rating ranking report for the account dashboard: the last 4 calendar months' bridge-aware average ratings, broken out per year across roughly the last 3+ years (start of ~3y4m ago through end of this month), grouped by year. Each year row carries the four most-recent month names as columns.

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

Rate limit: No rate limit.

Request

  • Query: review_site_id (integer, optional) — filter to one platform; must be an existing review site.
  • NOTE: The endpoint accepts store_id by the form request (validated by an ownership check if present) but the report always aggregates across the caller's whole account tree. There are no range params on this endpoint (the window is fixed server-side).

Response{ data: [.] } envelope; an array of year rows in ascending year order. Each row has Year (integer) plus one key per the four most-recent month names (full month name, e.g. March) → average rating for that month/year (number; 0 when no data).

Errors: 422 on validation failure.

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