Get Satisfaction Rating

Request

GET /v2/ratings/1 HTTP/1.1
Authorization: Bearer oauth_token

Path Parameters

/v2/ratings/{ratingId}

Response

HTTP/1.1 200 OK
Set-Cookie: JSESSIONID=25C6DD43E5182674A8590D684C7EE537; Path=/; HttpOnly
Content-Type: application/hal+json

{
  "id" : 1,
  "customer" : {
    "id" : 500,
    "email" : "customer@acme.com",
    "firstName" : "Happy",
    "lastName" : "Customer",
    "photoUrl" : "http://twitter.com/img/some-avatar.jpg"
  },
  "threadId" : 10,
  "conversationId" : 123,
  "mailboxId" : 85,
  "rating" : "great",
  "user" : {
    "id" : 11,
    "email" : "bear@acme.com",
    "firstName" : "Vernon",
    "lastName" : "Bear"
  },
  "comments" : "Well done!",
  "createdAt" : "2017-12-12T12:12:13",
  "_links" : {
    "conversation" : {
      "href" : "..."
    },
    "mailbox" : {
      "href" : "..."
    },
    "customer" : {
      "href" : "..."
    },
    "user" : {
      "href" : "..."
    },
    "self" : {
      "href" : "..."
    }
  }
}

Response fields

Path Type Description
id Number Rating’s ID
threadId Number Thread to which the rating is attached
conversationId Number Parent conversation
mailboxId Number Conversation’s mailbox
comments String Optional comment entered by the user
rating String Rating - one of:
great
not_good
okay
unknown
createdAt String UTC time when the rating was added
modifiedAt String UTC time when the rating was updated
user Object User whose reply was rated by the customer
customer Object Customer that added the reply
↑Back to top
© Help Scout 2024