TCL / Support API / List Audits for a Ticket
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/tickets/:ticket_id/audits" $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)
# {
# "audits": [
# {
# "author_id": "<integer>",
# "created_at": "<dateTime>",
# "events": [
# {
# "in14": 98255426.2140105,
# "consequat_b9": false,
# "Lorem4": -18718960,
# "incididunt_a": 91476803.94307658
# },
# {
# "ipsume1": -99329065,
# "laboris_8c": 89859673.3933256,
# "consectetur6": true
# }
# ],
# "id": "<integer>",
# "metadata": {
# "fugiat2_": 32930402.342455566,
# "aliqua4f": false
# },
# "ticket_id": "<integer>",
# "via": {
# "channel": "<string>",
# "source": {
# "amet29d": "veniam",
# "aliqua_b0": -53884767.66002053,
# "amet_24": 77146472.24303994,
# "non_b8": 30237848
# }
# }
# },
# {
# "author_id": "<integer>",
# "created_at": "<dateTime>",
# "events": [
# {
# "officia1": true
# },
# {
# "minim_27": true,
# "Ut7_2": -37549201.88334068
# }
# ],
# "id": "<integer>",
# "metadata": {
# "in_3a": 96878618,
# "occaecat_d98": 24309571
# },
# "ticket_id": "<integer>",
# "via": {
# "channel": "<string>",
# "source": {
# "commodo_60e": true
# }
# }
# }
# ],
# "count": "<integer>",
# "next_page": "<string>",
# "previous_page": "<string>"
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
set count [CkJsonObject_stringOf $jResp "count"]
set next_page [CkJsonObject_stringOf $jResp "next_page"]
set previous_page [CkJsonObject_stringOf $jResp "previous_page"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "audits"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set author_id [CkJsonObject_stringOf $jResp "audits[i].author_id"]
set created_at [CkJsonObject_stringOf $jResp "audits[i].created_at"]
set id [CkJsonObject_stringOf $jResp "audits[i].id"]
set Fugiat2_ [CkJsonObject_stringOf $jResp "audits[i].metadata.fugiat2_"]
set Aliqua4f [CkJsonObject_BoolOf $jResp "audits[i].metadata.aliqua4f"]
set ticket_id [CkJsonObject_stringOf $jResp "audits[i].ticket_id"]
set Channel [CkJsonObject_stringOf $jResp "audits[i].via.channel"]
set Amet29d [CkJsonObject_stringOf $jResp "audits[i].via.source.amet29d"]
set Aliqua_b0 [CkJsonObject_stringOf $jResp "audits[i].via.source.aliqua_b0"]
set Amet_24 [CkJsonObject_stringOf $jResp "audits[i].via.source.amet_24"]
set Non_b8 [CkJsonObject_IntOf $jResp "audits[i].via.source.non_b8"]
set In_3a [CkJsonObject_IntOf $jResp "audits[i].metadata.in_3a"]
set Occaecat_d98 [CkJsonObject_IntOf $jResp "audits[i].metadata.occaecat_d98"]
set Commodo_60e [CkJsonObject_BoolOf $jResp "audits[i].via.source.commodo_60e"]
set j 0
set count_j [CkJsonObject_SizeOfArray $jResp "audits[i].events"]
while {$j < $count_j} {
CkJsonObject_put_J $jResp $j
set in14 [CkJsonObject_stringOf $jResp "audits[i].events[j].in14"]
set consequat_b9 [CkJsonObject_BoolOf $jResp "audits[i].events[j].consequat_b9"]
set Lorem4 [CkJsonObject_IntOf $jResp "audits[i].events[j].Lorem4"]
set incididunt_a [CkJsonObject_stringOf $jResp "audits[i].events[j].incididunt_a"]
set ipsume1 [CkJsonObject_IntOf $jResp "audits[i].events[j].ipsume1"]
set laboris_8c [CkJsonObject_stringOf $jResp "audits[i].events[j].laboris_8c"]
set consectetur6 [CkJsonObject_BoolOf $jResp "audits[i].events[j].consectetur6"]
set officia1 [CkJsonObject_BoolOf $jResp "audits[i].events[j].officia1"]
set minim_27 [CkJsonObject_BoolOf $jResp "audits[i].events[j].minim_27"]
set Ut7_2 [CkJsonObject_stringOf $jResp "audits[i].events[j].Ut7_2"]
set j [expr $j + 1]
}
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/tickets/:ticket_id/audits
Postman Collection Item JSON
{
"name": "List Audits for a Ticket",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/tickets/:ticket_id/audits",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"tickets",
":ticket_id",
"audits"
],
"variable": [
{
"key": "ticket_id",
"value": "<integer>"
}
]
},
"description": "Lists the audits for a specified ticket.\n\n#### Pagination\n\n- Cursor pagination (recommended)\n- Offset pagination\n\nSee [Pagination](/api-reference/introduction/pagination/).\n\nReturns a maximum of 100 records per page.\n\n**Note**: Audits for [Archived Tickets](https://support.zendesk.com/hc/en-us/articles/4408887617050) do not support pagination for this endpoint.\n\n#### Allowed for\n\n* Agents\n"
},
"response": [
{
"name": "OK response",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/tickets/:ticket_id/audits",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"tickets",
":ticket_id",
"audits"
],
"variable": [
{
"key": "ticket_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"audits\": [\n {\n \"author_id\": \"<integer>\",\n \"created_at\": \"<dateTime>\",\n \"events\": [\n {\n \"in14\": 98255426.2140105,\n \"consequat_b9\": false,\n \"Lorem4\": -18718960,\n \"incididunt_a\": 91476803.94307658\n },\n {\n \"ipsume1\": -99329065,\n \"laboris_8c\": 89859673.3933256,\n \"consectetur6\": true\n }\n ],\n \"id\": \"<integer>\",\n \"metadata\": {\n \"fugiat2_\": 32930402.342455566,\n \"aliqua4f\": false\n },\n \"ticket_id\": \"<integer>\",\n \"via\": {\n \"channel\": \"<string>\",\n \"source\": {\n \"amet29d\": \"veniam\",\n \"aliqua_b0\": -53884767.66002053,\n \"amet_24\": 77146472.24303994,\n \"non_b8\": 30237848\n }\n }\n },\n {\n \"author_id\": \"<integer>\",\n \"created_at\": \"<dateTime>\",\n \"events\": [\n {\n \"officia1\": true\n },\n {\n \"minim_27\": true,\n \"Ut7_2\": -37549201.88334068\n }\n ],\n \"id\": \"<integer>\",\n \"metadata\": {\n \"in_3a\": 96878618,\n \"occaecat_d98\": 24309571\n },\n \"ticket_id\": \"<integer>\",\n \"via\": {\n \"channel\": \"<string>\",\n \"source\": {\n \"commodo_60e\": true\n }\n }\n }\n ],\n \"count\": \"<integer>\",\n \"next_page\": \"<string>\",\n \"previous_page\": \"<string>\"\n}"
}
]
}
