Sentiment breakdown

Overview

Get the number of positive, neutral, and negative reviews. The counts cover all reviews, not a period.

Use this for a sentiment chart.

You'll need a partner token.

Returns the three counts.

Prerequisites

• A Partner bearer token. See Authentication.

Base URL

Endpoint

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

Authentication

Partner token

• Results cover the active and pending locations of accounts directly under your partner or under its sub-partners.
• When the user behind the token is limited to some accounts, only those accounts are counted.
• Reviews from a site that's been removed from the location aren't counted.

Rate limit

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

Request parameters

None.

Request body

None.

Request payload

None.

Response body

The payload is inside data.

Response payload

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

Examples

Success payload

See Response payload.

No reviews yet:

{
  "data": {
    "positive_count": 0,
    "neutral_count": 0,
    "negative_count": 0
  }
}

Error payload

401 Unauthenticated

{
  "message": "Unauthenticated."
}

429 Too many requests

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

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'