Get annual volume + rating stats

Overview

Retrieve account-dashboard review volume and rating statistics for the last 13 complete months. The fixed window starts at the beginning of the month 13 months ago and ends on the last day of the previous month. Rating calculations span all connected sites for hipages stores.

Prerequisites

• Obtain an Account bearer token.

Base URL

Endpoint

GET /api/v1/account/dashboard/get-annual-volume-rating-stats

Authentication

Send your Account bearer token in the Authorization: Bearer <bearer-token> header.

• This endpoint is role-agnostic within the account/dashboard group.
• Its scope is the caller's company tree.
• When you provide store_id, the API verifies that the caller's company owns the store.
• If you omit store_id, the response includes all of the caller's stores.

Rate limit

This endpoint has no rate limit.

Query parameters

Response

The response contains a data array with one object for each month in the fixed window.

200 Success · 200

{
  "data": [
    {
      "month": "Jun 2025",
      "reviews": 87,
      "responses": 24,
      "monthly_avg_rating": 4.12,
      "overall_rating": 4.28
    },
    {
      "month": "Jul 2025",
      "reviews": 102,
      "responses": 31,
      "monthly_avg_rating": 4.18,
      "overall_rating": 4.28
    }
  ]
}

Errors

Example request

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