Skip to main content
GET
/
api
/
public
/
v1
/
notes
/
{note_id}
/
ratings
/
stats
Get Rating Stats Jsonapi
curl --request GET \
  --url https://api.example.com/api/public/v1/notes/{note_id}/ratings/stats \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "id": "<string>",
    "attributes": {
      "total": 123,
      "helpful": 123,
      "somewhat_helpful": 123,
      "not_helpful": 123,
      "average_score": 123
    },
    "type": "rating-stats"
  },
  "jsonapi": {
    "version": "1.1"
  },
  "links": {
    "self_": "<string>",
    "first": "<string>",
    "last": "<string>",
    "prev": "<string>",
    "next_": "<string>",
    "describedby": "<string>"
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-API-Key
string | null

Path Parameters

note_id
string<uuid>
required

Response

Successful Response

JSON:API response for rating statistics.

data
RatingStatsResource · object
required

JSON:API resource object for rating statistics.

jsonapi
Jsonapi · object

JSON:API links object for pagination and resource links.

Uses field aliases for 'self' and 'next' which are Python reserved words. Always use by_alias=True when serializing. Includes JSON:API 1.1 'describedby' link for API documentation.