Review sentiments (positive / neutral / negative)

Overview

Get the review sentiment breakdown (positive / neutral / negative review counts) for the authenticated partner.

Prerequisites

• A bearer token. Callable with Partner tokens.

Base URL

Endpoint

GET /api/v1/partner/stats/review-sentiments

Authentication

• Requires a bearer token in the Authorization: Bearer <bearer-token> header.

• Who can call it: Partner tokens.

• Mounted under the partner/stats group.

• Scope joins store, then company, then brand, then partner and requires partner.bundle_id=1 matching (as the partner itself or a sub-partner via partner.company_id), restricted to active/pending stores.

• assign_brand narrows further to assignBrands.

• Sentiment buckets: negative = rate < 3 (with the site_id=3 carve-out requiring rate > 0), positive = rate > 3, neutral = everything else.

Rate limit

• No rate limit.

Request

• No path, query, or body params (reads the authenticated user only).

Response

• data.positive_count (int) — reviews with rate > 3.
• data.neutral_count (int) — reviews that are neither positive nor negative (for example, rate == 3 or site_id=3 with rate 0).
• data.negative_count (int) — reviews with rate < 3 (site_id=3 requires rate > 0 to count).

200 Success · 200

{
  "data": {
    "positive_count": 1240,
    "neutral_count": 180,
    "negative_count": 95
  }
}

Errors

Example request

curl --request GET \
  --url "https://production-api.shoutaboutus.com/api/v1/partner/stats/review-sentiments" \
  --header 'Authorization: Bearer <bearer-token>' \
  --header 'Accept: application/json'