Get monthly ranking report

Overview

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

Prerequisites

• A bearer token. Callable with Account tokens.

Base URL

Endpoint

GET /api/v1/account/dashboard/get-ranking-report

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 (stores whose location-account's parent account = user.person.company.id).

Rate limit

• No rate limit.

Query parameters

• 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

200 Success · 200

{
  "data": [
    { "Year": 2025, "April": 4.1, "May": 4.2, "June": 4.0, "July": 4.3 },
    { "Year": 2026, "April": 4.4, "May": 4.5, "June": 0, "July": 0 }
  ]
}

Errors

Example request

curl --request GET \
  --url "https://production-api.shoutaboutus.com/api/v1/account/dashboard/get-ranking-report?store_id=123&review_site_id=123" \
  --header 'Authorization: Bearer <bearer-token>' \
  --header 'Accept: application/json'