TCL / Support API / List Satisfaction Ratings
Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set http [new_CkHttp]
CkHttp_put_BasicAuth $http 1
CkHttp_put_Login $http "login"
CkHttp_put_Password $http "password"
CkHttp_SetRequestHeader $http "Accept" "application/json"
set sbResponseBody [new_CkStringBuilder]
set success [CkHttp_QuickGetSb $http "https://example.zendesk.com/api/v2/satisfaction_ratings" $sbResponseBody]
if {$success == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
exit
}
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0
puts "Response Body:"
puts [CkJsonObject_emit $jResp]
set respStatusCode [CkHttp_get_LastStatus $http]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttp_lastHeader $http]
puts "Failed."
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "satisfaction_ratings": [
# {
# "assignee_id": "<integer>",
# "group_id": "<integer>",
# "requester_id": "<integer>",
# "ticket_id": "<integer>",
# "score": "<string>",
# "comment": "<string>",
# "created_at": "<dateTime>",
# "id": "<integer>",
# "reason": "<string>",
# "reason_code": "<integer>",
# "reason_id": "<integer>",
# "updated_at": "<dateTime>",
# "url": "<string>"
# },
# {
# "assignee_id": "<integer>",
# "group_id": "<integer>",
# "requester_id": "<integer>",
# "ticket_id": "<integer>",
# "score": "<string>",
# "comment": "<string>",
# "created_at": "<dateTime>",
# "id": "<integer>",
# "reason": "<string>",
# "reason_code": "<integer>",
# "reason_id": "<integer>",
# "updated_at": "<dateTime>",
# "url": "<string>"
# }
# ]
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "satisfaction_ratings"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set assignee_id [CkJsonObject_stringOf $jResp "satisfaction_ratings[i].assignee_id"]
set group_id [CkJsonObject_stringOf $jResp "satisfaction_ratings[i].group_id"]
set requester_id [CkJsonObject_stringOf $jResp "satisfaction_ratings[i].requester_id"]
set ticket_id [CkJsonObject_stringOf $jResp "satisfaction_ratings[i].ticket_id"]
set score [CkJsonObject_stringOf $jResp "satisfaction_ratings[i].score"]
set comment [CkJsonObject_stringOf $jResp "satisfaction_ratings[i].comment"]
set created_at [CkJsonObject_stringOf $jResp "satisfaction_ratings[i].created_at"]
set id [CkJsonObject_stringOf $jResp "satisfaction_ratings[i].id"]
set reason [CkJsonObject_stringOf $jResp "satisfaction_ratings[i].reason"]
set reason_code [CkJsonObject_stringOf $jResp "satisfaction_ratings[i].reason_code"]
set reason_id [CkJsonObject_stringOf $jResp "satisfaction_ratings[i].reason_id"]
set updated_at [CkJsonObject_stringOf $jResp "satisfaction_ratings[i].updated_at"]
set url [CkJsonObject_stringOf $jResp "satisfaction_ratings[i].url"]
set i [expr $i + 1]
}
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
Curl Command
curl -u login:password -X GET
-H "Accept: application/json"
https://example.zendesk.com/api/v2/satisfaction_ratings
Postman Collection Item JSON
{
"name": "List Satisfaction Ratings",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/satisfaction_ratings",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"satisfaction_ratings"
]
},
"description": "#### Allowed For\n* Agents\n\n#### Filters\n\n| Parameter | Value\n| ---------- | -----\n| score | offered, unoffered, received, received\\_with\\_comment, received\\_without\\_comment,<br/>good, good\\_with\\_comment, good\\_without\\_comment,<br/>bad, bad\\_with\\_comment, bad\\_without\\_comment\n| start_time | Time of the oldest satisfaction rating, as a [Unix epoch time](https://www.epochconverter.com/)\n| end_time | Time of the most recent satisfaction rating, as a [Unix epoch time](https://www.epochconverter.com/)\n\nIf you specify an unqualified score such as `good`, the results include all the records with and without comments.\n\nExamples:\n\n* `/api/v2/satisfaction_ratings.json?score=bad`\n* `/api/v2/satisfaction_ratings.json?score=bad&start_time=1498151194`\n* `/api/v2/satisfaction_ratings.json?start_time=1340384793&end_time=1371920793`\n"
},
"response": [
{
"name": "Success response",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/satisfaction_ratings",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"satisfaction_ratings"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"satisfaction_ratings\": [\n {\n \"assignee_id\": \"<integer>\",\n \"group_id\": \"<integer>\",\n \"requester_id\": \"<integer>\",\n \"ticket_id\": \"<integer>\",\n \"score\": \"<string>\",\n \"comment\": \"<string>\",\n \"created_at\": \"<dateTime>\",\n \"id\": \"<integer>\",\n \"reason\": \"<string>\",\n \"reason_code\": \"<integer>\",\n \"reason_id\": \"<integer>\",\n \"updated_at\": \"<dateTime>\",\n \"url\": \"<string>\"\n },\n {\n \"assignee_id\": \"<integer>\",\n \"group_id\": \"<integer>\",\n \"requester_id\": \"<integer>\",\n \"ticket_id\": \"<integer>\",\n \"score\": \"<string>\",\n \"comment\": \"<string>\",\n \"created_at\": \"<dateTime>\",\n \"id\": \"<integer>\",\n \"reason\": \"<string>\",\n \"reason_code\": \"<integer>\",\n \"reason_id\": \"<integer>\",\n \"updated_at\": \"<dateTime>\",\n \"url\": \"<string>\"\n }\n ]\n}"
}
]
}
