Chilkat Online Tools

Xojo / Support API / List Satisfaction Ratings

Back to Collection Items

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

Dim http As New Chilkat.Http
Dim success As Boolean

http.BasicAuth = True
http.Login = "login"
http.Password = "password"

http.SetRequestHeader "Accept","application/json"

Dim sbResponseBody As New Chilkat.StringBuilder
success = http.QuickGetSb("https://example.zendesk.com/api/v2/satisfaction_ratings",sbResponseBody)
If (success = False) Then
    System.DebugLog(http.LastErrorText)
    Return
End If

Dim jResp As New Chilkat.JsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

System.DebugLog("Response Body:")
System.DebugLog(jResp.Emit())

Dim respStatusCode As Int32
respStatusCode = http.LastStatus
System.DebugLog("Response Status Code = " + Str(respStatusCode))
If (respStatusCode >= 400) Then
    System.DebugLog("Response Header:")
    System.DebugLog(http.LastHeader)
    System.DebugLog("Failed.")
    Return
End If

// 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

Dim assignee_id As String
Dim group_id As String
Dim requester_id As String
Dim ticket_id As String
Dim score As String
Dim comment As String
Dim created_at As String
Dim id As String
Dim reason As String
Dim reason_code As String
Dim reason_id As String
Dim updated_at As String
Dim url As String

Dim i As Int32
i = 0
Dim count_i As Int32
count_i = jResp.SizeOfArray("satisfaction_ratings")
While i < count_i
    jResp.I = i
    assignee_id = jResp.StringOf("satisfaction_ratings[i].assignee_id")
    group_id = jResp.StringOf("satisfaction_ratings[i].group_id")
    requester_id = jResp.StringOf("satisfaction_ratings[i].requester_id")
    ticket_id = jResp.StringOf("satisfaction_ratings[i].ticket_id")
    score = jResp.StringOf("satisfaction_ratings[i].score")
    comment = jResp.StringOf("satisfaction_ratings[i].comment")
    created_at = jResp.StringOf("satisfaction_ratings[i].created_at")
    id = jResp.StringOf("satisfaction_ratings[i].id")
    reason = jResp.StringOf("satisfaction_ratings[i].reason")
    reason_code = jResp.StringOf("satisfaction_ratings[i].reason_code")
    reason_id = jResp.StringOf("satisfaction_ratings[i].reason_id")
    updated_at = jResp.StringOf("satisfaction_ratings[i].updated_at")
    url = jResp.StringOf("satisfaction_ratings[i].url")
    i = i + 1
Wend

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}"
    }
  ]
}