autoit / Support API / List Audits for a Ticket
Back to Collection Items
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess
$oHttp.BasicAuth = True
$oHttp.Login = "login"
$oHttp.Password = "password"
$oHttp.SetRequestHeader "Accept","application/json"
$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$bSuccess = $oHttp.QuickGetSb("https://example.zendesk.com/api/v2/tickets/:ticket_id/audits",$oSbResponseBody)
If ($bSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False
ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)
Local $iRespStatusCode = $oHttp.LastStatus
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
ConsoleWrite("Response Header:" & @CRLF)
ConsoleWrite($oHttp.LastHeader & @CRLF)
ConsoleWrite("Failed." & @CRLF)
Exit
EndIf
; 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
Local $sAuthor_id
Local $sCreated_at
Local $sId
Local $sFugiat2_
Local $bAliqua4f
Local $sTicket_id
Local $sChannel
Local $sAmet29d
Local $sAliqua_b0
Local $sAmet_24
Local $iNon_b8
Local $iIn_3a
Local $iOccaecat_d98
Local $bCommodo_60e
Local $iJ
Local $iCount_j
Local $sIn14
Local $bConsequat_b9
Local $iLorem4
Local $sIncididunt_a
Local $ipsume1
Local $sLaboris_8c
Local $bConsectetur6
Local $bOfficia1
Local $bMinim_27
Local $sUt7_2
Local $sCount = $oJResp.StringOf("count")
Local $sNext_page = $oJResp.StringOf("next_page")
Local $sPrevious_page = $oJResp.StringOf("previous_page")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("audits")
While $i < $iCount_i
$oJResp.I = $i
$sAuthor_id = $oJResp.StringOf("audits[i].author_id")
$sCreated_at = $oJResp.StringOf("audits[i].created_at")
$sId = $oJResp.StringOf("audits[i].id")
$sFugiat2_ = $oJResp.StringOf("audits[i].metadata.fugiat2_")
$bAliqua4f = $oJResp.BoolOf("audits[i].metadata.aliqua4f")
$sTicket_id = $oJResp.StringOf("audits[i].ticket_id")
$sChannel = $oJResp.StringOf("audits[i].via.channel")
$sAmet29d = $oJResp.StringOf("audits[i].via.source.amet29d")
$sAliqua_b0 = $oJResp.StringOf("audits[i].via.source.aliqua_b0")
$sAmet_24 = $oJResp.StringOf("audits[i].via.source.amet_24")
$iNon_b8 = $oJResp.IntOf("audits[i].via.source.non_b8")
$iIn_3a = $oJResp.IntOf("audits[i].metadata.in_3a")
$iOccaecat_d98 = $oJResp.IntOf("audits[i].metadata.occaecat_d98")
$bCommodo_60e = $oJResp.BoolOf("audits[i].via.source.commodo_60e")
$iJ = 0
$iCount_j = $oJResp.SizeOfArray("audits[i].events")
While $iJ < $iCount_j
$oJResp.J = $iJ
$sIn14 = $oJResp.StringOf("audits[i].events[j].in14")
$bConsequat_b9 = $oJResp.BoolOf("audits[i].events[j].consequat_b9")
$iLorem4 = $oJResp.IntOf("audits[i].events[j].Lorem4")
$sIncididunt_a = $oJResp.StringOf("audits[i].events[j].incididunt_a")
$ipsume1 = $oJResp.IntOf("audits[i].events[j].ipsume1")
$sLaboris_8c = $oJResp.StringOf("audits[i].events[j].laboris_8c")
$bConsectetur6 = $oJResp.BoolOf("audits[i].events[j].consectetur6")
$bOfficia1 = $oJResp.BoolOf("audits[i].events[j].officia1")
$bMinim_27 = $oJResp.BoolOf("audits[i].events[j].minim_27")
$sUt7_2 = $oJResp.StringOf("audits[i].events[j].Ut7_2")
$iJ = $iJ + 1
Wend
$i = $i + 1
Wend
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}"
}
]
}
