List Satisfaction Ratings

GET {{baseUrl}}/api/v2/satisfaction_ratings

Allowed For

  • Agents

Filters

ParameterValue
scoreoffered, unoffered, received, received_with_comment, received_without_comment,
good, good_with_comment, good_without_comment,
bad, bad_with_comment, bad_without_comment
start_timeTime of the oldest satisfaction rating, as a Unix epoch time
end_timeTime of the most recent satisfaction rating, as a Unix epoch time

If you specify an unqualified score such as good, the results include all the records with and without comments.

Examples:

  • /api/v2/satisfaction_ratings.json?score=bad
  • /api/v2/satisfaction_ratings.json?score=bad&start_time=1498151194
  • /api/v2/satisfaction_ratings.json?start_time=1340384793&end_time=1371920793

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{"satisfaction_ratings":[{"assignee_id":135,"comment":"Awesome support!","created_at":"2011-07-20T22:55:29Z","group_id":44,"id":35436,"requester_id":7881,"score":"good","ticket_id":208,"updated_at":"2011-07-20T22:55:29Z","url":"https://example.zendesk.com/api/v2/satisfaction_ratings/35436.json"},{"assignee_id":136,"comment":"Awesome support!","created_at":"2012-02-01T04:31:29Z","group_id":44,"id":120447,"requester_id":7881,"score":"good","ticket_id":209,"updated_at":"2012-02-02T10:32:59Z","url":"https://example.zendesk.com/api/v2/satisfaction_ratings/120447.json"}]}