TCL / Support API / List All Ticket Audits
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"
set queryParams [new_CkJsonObject]
CkJsonObject_UpdateString $queryParams "limit" "<integer>"
CkHttp_SetRequestHeader $http "Accept" "application/json"
# resp is a CkHttpResponse
set resp [CkHttp_QuickRequestParams $http "GET" "https://example.zendesk.com/api/v2/ticket_audits" $queryParams]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkJsonObject $queryParams
exit
}
set sbResponseBody [new_CkStringBuilder]
CkHttpResponse_GetBodySb $resp $sbResponseBody
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0
puts "Response Body:"
puts [CkJsonObject_emit $jResp]
set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttpResponse_header $resp]
puts "Failed."
delete_CkHttpResponse $resp
delete_CkHttp $http
delete_CkJsonObject $queryParams
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
delete_CkHttpResponse $resp
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "after_cursor": "<string>",
# "after_url": "<string>",
# "audits": [
# {
# "author_id": "<integer>",
# "created_at": "<dateTime>",
# "events": [
# {
# "voluptate_edf": 37194901.82832828,
# "dolor0": 61753613
# },
# {
# "sedb2": false
# }
# ],
# "id": "<integer>",
# "metadata": {
# "aute__": "proident aute qui culpa",
# "ex_ae": "dolore Lorem labore ut"
# },
# "ticket_id": "<integer>",
# "via": {
# "channel": "<string>",
# "source": {
# "et_c59": 68912889
# }
# }
# },
# {
# "author_id": "<integer>",
# "created_at": "<dateTime>",
# "events": [
# {
# "nostrud_fd6": -68241256.05178377
# },
# {
# "ullamcoe": "ad",
# "adipisicing_1": false
# }
# ],
# "id": "<integer>",
# "metadata": {
# "veniam_689": -18333948.100650415,
# "elit_2ab": "eu dolor deserunt consequat dolore"
# },
# "ticket_id": "<integer>",
# "via": {
# "channel": "<string>",
# "source": {
# "sint490": -68016605.99205834
# }
# }
# }
# ],
# "before_cursor": "<string>",
# "before_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 after_cursor [CkJsonObject_stringOf $jResp "after_cursor"]
set after_url [CkJsonObject_stringOf $jResp "after_url"]
set before_cursor [CkJsonObject_stringOf $jResp "before_cursor"]
set before_url [CkJsonObject_stringOf $jResp "before_url"]
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 Aute__ [CkJsonObject_stringOf $jResp "audits[i].metadata.aute__"]
set Ex_ae [CkJsonObject_stringOf $jResp "audits[i].metadata.ex_ae"]
set ticket_id [CkJsonObject_stringOf $jResp "audits[i].ticket_id"]
set Channel [CkJsonObject_stringOf $jResp "audits[i].via.channel"]
set Et_c59 [CkJsonObject_IntOf $jResp "audits[i].via.source.et_c59"]
set Veniam_689 [CkJsonObject_stringOf $jResp "audits[i].metadata.veniam_689"]
set Elit_2ab [CkJsonObject_stringOf $jResp "audits[i].metadata.elit_2ab"]
set Sint490 [CkJsonObject_stringOf $jResp "audits[i].via.source.sint490"]
set j 0
set count_j [CkJsonObject_SizeOfArray $jResp "audits[i].events"]
while {$j < $count_j} {
CkJsonObject_put_J $jResp $j
set voluptate_edf [CkJsonObject_stringOf $jResp "audits[i].events[j].voluptate_edf"]
set dolor0 [CkJsonObject_IntOf $jResp "audits[i].events[j].dolor0"]
set sedb2 [CkJsonObject_BoolOf $jResp "audits[i].events[j].sedb2"]
set nostrud_fd6 [CkJsonObject_stringOf $jResp "audits[i].events[j].nostrud_fd6"]
set ullamcoe [CkJsonObject_stringOf $jResp "audits[i].events[j].ullamcoe"]
set adipisicing_1 [CkJsonObject_BoolOf $jResp "audits[i].events[j].adipisicing_1"]
set j [expr $j + 1]
}
set i [expr $i + 1]
}
delete_CkHttp $http
delete_CkJsonObject $queryParams
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
Curl Command
curl -u login:password -G -d "limit=%3Cinteger%3E"
-H "Accept: application/json"
https://example.zendesk.com/api/v2/ticket_audits
Postman Collection Item JSON
{
"name": "List All Ticket Audits",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/ticket_audits?limit=<integer>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ticket_audits"
],
"query": [
{
"key": "limit",
"value": "<integer>",
"description": "Maximum number of results returned"
}
]
},
"description": "Returns ticket audits. Archived tickets are not included in the response. Use the [List Audits for a Ticket](#list-audits-for-a-ticket) endpoint to \nretrieve audit records for an archived ticket. To learn more about archived tickets, see [About archived tickets](https://support.zendesk.com/hc/en-us/articles/203657756).\n\nThis endpoint should not be used for capturing change data. When continually chasing the tail of a cursor, some records will be skipped. For this use case, use the [Incremental Ticket Event Export API](/api-reference/ticketing/ticket-management/incremental_exports/#incremental-ticket-event-export).\n\n#### Pagination\n\n- Cursor pagination\n\nSee [Pagination](/api-reference/introduction/pagination/).\n\nReturns a maximum of 100 records per page.\n\n#### Allowed For\n\n* Admins\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/ticket_audits?limit=<integer>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"ticket_audits"
],
"query": [
{
"key": "limit",
"value": "<integer>",
"description": "Maximum number of results returned"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"after_cursor\": \"<string>\",\n \"after_url\": \"<string>\",\n \"audits\": [\n {\n \"author_id\": \"<integer>\",\n \"created_at\": \"<dateTime>\",\n \"events\": [\n {\n \"voluptate_edf\": 37194901.82832828,\n \"dolor0\": 61753613\n },\n {\n \"sedb2\": false\n }\n ],\n \"id\": \"<integer>\",\n \"metadata\": {\n \"aute__\": \"proident aute qui culpa\",\n \"ex_ae\": \"dolore Lorem labore ut\"\n },\n \"ticket_id\": \"<integer>\",\n \"via\": {\n \"channel\": \"<string>\",\n \"source\": {\n \"et_c59\": 68912889\n }\n }\n },\n {\n \"author_id\": \"<integer>\",\n \"created_at\": \"<dateTime>\",\n \"events\": [\n {\n \"nostrud_fd6\": -68241256.05178377\n },\n {\n \"ullamcoe\": \"ad\",\n \"adipisicing_1\": false\n }\n ],\n \"id\": \"<integer>\",\n \"metadata\": {\n \"veniam_689\": -18333948.100650415,\n \"elit_2ab\": \"eu dolor deserunt consequat dolore\"\n },\n \"ticket_id\": \"<integer>\",\n \"via\": {\n \"channel\": \"<string>\",\n \"source\": {\n \"sint490\": -68016605.99205834\n }\n }\n }\n ],\n \"before_cursor\": \"<string>\",\n \"before_url\": \"<string>\"\n}"
}
]
}
