Review sentiments (positive / neutral / negative)

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

Auth: Partner — authentication (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 a Google 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. } envelope.

  • positive_count (int) — reviews with rate > 3.
  • neutral_count (int) — reviews that are neither positive nor negative (e.g. rate == 3, or Google site_id=3 with rate 0).
  • negative_count (int) — reviews with rate < 3 (Google site_id=3 requires rate > 0 to count).
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
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