Get sentiment overview

Sentiment overview for the account dashboard: positive (4–5 star), neutral (3 star), and negative (1–2 star) review counts. Only qualifying, non-hipages-suppressed, rating-eligible reviews are counted. When both range_start and range_end are supplied it also returns a comparison block with per-sentiment period-over-period trends against the immediately-preceding window of equal length. Otherwise comparison is null.

Auth: Account — authentication, under the account/dashboard group (role-agnostic). Scope is the caller's own account company (brand.id = user.person.company.id). store_id (if given) validated by an ownership check and further constrains to that one store; assign_location users reach only their assigned stores.

Rate limit: No rate limit.

Request

  • Query: store_id (integer, optional) — must belong to the caller's company; constrains results to that store.
  • Query: review_site_id (integer, optional) — filter to one platform; must be an existing review site.
  • Query: range_start (string Y-m-d, optional) — both range params must be present for the date filter AND the comparison block to apply.
  • Query: range_end (string Y-m-d, optional) — must be ≥ range_start.
  • NOTE: the Postman URL for this endpoint omits review_site_id; it remains an accepted optional filter.

Response{ data: {.} } envelope.

  • positive_count (integer) — reviews with rate > 3.
  • neutral_count (integer) — middle band (effectively 3-star).
  • negative_count (integer) — rate 1–2 (Facebook only when rate > 0).
  • comparison (object|null) — null unless both range params given; contains previous_period ({ range_start, range_end }) plus a comparison cell per sentiment (positive_count, neutral_count, negative_count). Each cell = { current, previous, change_pct (float|null — null when previous is 0), direction ("up"|"down"|"flat") }.

Errors: 422 on validation failure.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
string
string
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