Powershell / Support API / List Audits for a Ticket
Back to Collection Items
Add-Type -Path "C:\chilkat\ChilkatDotNet47-x64\ChilkatDotNet47.dll"
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
$http = New-Object Chilkat.Http
$http.BasicAuth = $true
$http.Login = "login"
$http.Password = "password"
$http.SetRequestHeader("Accept","application/json")
$sbResponseBody = New-Object Chilkat.StringBuilder
$success = $http.QuickGetSb("https://example.zendesk.com/api/v2/tickets/:ticket_id/audits",$sbResponseBody)
if ($success -eq $false) {
$($http.LastErrorText)
exit
}
$jResp = New-Object Chilkat.JsonObject
$jResp.LoadSb($sbResponseBody)
$jResp.EmitCompact = $false
$("Response Body:")
$($jResp.Emit())
$respStatusCode = $http.LastStatus
$("Response Status Code = " + $respStatusCode)
if ($respStatusCode -ge 400) {
$("Response Header:")
$($http.LastHeader)
$("Failed.")
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
$count = $jResp.StringOf("count")
$next_page = $jResp.StringOf("next_page")
$previous_page = $jResp.StringOf("previous_page")
$i = 0
$count_i = $jResp.SizeOfArray("audits")
while ($i -lt $count_i) {
$jResp.I = $i
$author_id = $jResp.StringOf("audits[i].author_id")
$created_at = $jResp.StringOf("audits[i].created_at")
$id = $jResp.StringOf("audits[i].id")
$Fugiat2_ = $jResp.StringOf("audits[i].metadata.fugiat2_")
$Aliqua4f = $jResp.BoolOf("audits[i].metadata.aliqua4f")
$ticket_id = $jResp.StringOf("audits[i].ticket_id")
$Channel = $jResp.StringOf("audits[i].via.channel")
$Amet29d = $jResp.StringOf("audits[i].via.source.amet29d")
$Aliqua_b0 = $jResp.StringOf("audits[i].via.source.aliqua_b0")
$Amet_24 = $jResp.StringOf("audits[i].via.source.amet_24")
$Non_b8 = $jResp.IntOf("audits[i].via.source.non_b8")
$In_3a = $jResp.IntOf("audits[i].metadata.in_3a")
$Occaecat_d98 = $jResp.IntOf("audits[i].metadata.occaecat_d98")
$Commodo_60e = $jResp.BoolOf("audits[i].via.source.commodo_60e")
$j = 0
$count_j = $jResp.SizeOfArray("audits[i].events")
while ($j -lt $count_j) {
$jResp.J = $j
$in14 = $jResp.StringOf("audits[i].events[j].in14")
$consequat_b9 = $jResp.BoolOf("audits[i].events[j].consequat_b9")
$Lorem4 = $jResp.IntOf("audits[i].events[j].Lorem4")
$incididunt_a = $jResp.StringOf("audits[i].events[j].incididunt_a")
$ipsume1 = $jResp.IntOf("audits[i].events[j].ipsume1")
$laboris_8c = $jResp.StringOf("audits[i].events[j].laboris_8c")
$consectetur6 = $jResp.BoolOf("audits[i].events[j].consectetur6")
$officia1 = $jResp.BoolOf("audits[i].events[j].officia1")
$minim_27 = $jResp.BoolOf("audits[i].events[j].minim_27")
$Ut7_2 = $jResp.StringOf("audits[i].events[j].Ut7_2")
$j = $j + 1
}
$i = $i + 1
}
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}"
}
]
}
