Lifetime reviews by site

Overview

Get all-time totals by site for the account, next to the same site's figures for the period you choose.

Use this for a big-picture view.

You'll need a token and a date range. total_reviews and overall_rating are all-time; period_reviews and period_rating cover the date range.

Returns totals per site, the site with the most reviews first.

Prerequisites

• A bearer token. See Authentication.
• A date range (range_start, range_end), both Y-m-d H:i:s.
• Optional: a location id (store_id). Leave it out to report on every location your token can see.

Base URL

Endpoint

POST /api/v1/reports/response/reviews/publisher

Authentication

Partner or Account token

• store_id must be inside your own account tree; otherwise 422.
• Without store_id, the report covers every location the token can see: every location under the partner for a Partner token, the account's locations for an Account token, or only the assigned locations for a user limited to some locations.
• There are no account_id or client_* fields here.

Rate limit

120 requests per minute, counted per user (the token’s user). See Rate limits.

Request parameters

None.

Request body

Request payload

{
  "range_start": "2026-01-01 00:00:00",
  "range_end": "2026-09-30 23:59:59",
  "store_id": 3007
}

Response body

data is an array with one row per review site, sorted by total_reviews, highest first. Sites with no reviews at all are left out; it's [] when there are none.

Response payload

{
  "data": [
    {
      "id": 44,
      "review_site": "Google",
      "review_site_logo": "https://d2ny6zb7otrnhl.cloudfront.net/assets/backend/images/logos/google_ic.png",
      "review_site_color": "#4285F4",
      "total_reviews": 684,
      "overall_rating": 4.2,
      "period_reviews": 223,
      "period_rating": 4.4
    }
  ]
}

Examples

Success payload

One location: see Response payload.

No reviews:

{
  "data": []
}

Error payload

422 Dates missing

{
  "message": "The range start field is required. (and 1 more error)",
  "errors": {
    "range_start": [
      "The range start field is required."
    ],
    "range_end": [
      "The range end field is required."
    ]
  }
}

422 Date not in Y-m-d H:i:s

{
  "message": "The range start field must match the format Y-m-d H:i:s.",
  "errors": {
    "range_start": [
      "The range start field must match the format Y-m-d H:i:s."
    ]
  }
}

422 Location outside your tree

{
  "message": "The selected store id does not belong to your company hierarchy.",
  "errors": {
    "store_id": [
      "The selected store id does not belong to your company hierarchy."
    ]
  }
}

429 Too many requests

{
  "message": "Too Many Attempts."
}

Example request

curl --request POST \
  --url "https://production-api.shoutaboutus.com/api/v1/reports/response/reviews/publisher" \
  --header 'Authorization: Bearer <bearer-token>' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"range_start": "2026-01-01 00:00:00", "range_end": "2026-09-30 23:59:59", "store_id": 3007}'