PureBasic / Support API / List All Ticket Audits
Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
CkHttp::setCkBasicAuth(http, 1)
CkHttp::setCkLogin(http, "login")
CkHttp::setCkPassword(http, "password")
queryParams.i = CkJsonObject::ckCreate()
If queryParams.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(queryParams,"limit","<integer>")
CkHttp::ckSetRequestHeader(http,"Accept","application/json")
resp.i = CkHttp::ckQuickRequestParams(http,"GET","https://example.zendesk.com/api/v2/ticket_audits",queryParams)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
ProcedureReturn
EndIf
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttpResponse::ckHeader(resp)
Debug "Failed."
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
CkHttpResponse::ckDispose(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
author_id.s
created_at.s
id.s
Aute__.s
Ex_ae.s
ticket_id.s
Channel.s
Et_c59.i
Veniam_689.s
Elit_2ab.s
Sint490.s
j.i
count_j.i
voluptate_edf.s
dolor0.i
sedb2.i
nostrud_fd6.s
ullamcoe.s
adipisicing_1.i
after_cursor.s = CkJsonObject::ckStringOf(jResp,"after_cursor")
after_url.s = CkJsonObject::ckStringOf(jResp,"after_url")
before_cursor.s = CkJsonObject::ckStringOf(jResp,"before_cursor")
before_url.s = CkJsonObject::ckStringOf(jResp,"before_url")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"audits")
While i < count_i
CkJsonObject::setCkI(jResp, i)
author_id = CkJsonObject::ckStringOf(jResp,"audits[i].author_id")
created_at = CkJsonObject::ckStringOf(jResp,"audits[i].created_at")
id = CkJsonObject::ckStringOf(jResp,"audits[i].id")
Aute__ = CkJsonObject::ckStringOf(jResp,"audits[i].metadata.aute__")
Ex_ae = CkJsonObject::ckStringOf(jResp,"audits[i].metadata.ex_ae")
ticket_id = CkJsonObject::ckStringOf(jResp,"audits[i].ticket_id")
Channel = CkJsonObject::ckStringOf(jResp,"audits[i].via.channel")
Et_c59 = CkJsonObject::ckIntOf(jResp,"audits[i].via.source.et_c59")
Veniam_689 = CkJsonObject::ckStringOf(jResp,"audits[i].metadata.veniam_689")
Elit_2ab = CkJsonObject::ckStringOf(jResp,"audits[i].metadata.elit_2ab")
Sint490 = CkJsonObject::ckStringOf(jResp,"audits[i].via.source.sint490")
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"audits[i].events")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
voluptate_edf = CkJsonObject::ckStringOf(jResp,"audits[i].events[j].voluptate_edf")
dolor0 = CkJsonObject::ckIntOf(jResp,"audits[i].events[j].dolor0")
sedb2 = CkJsonObject::ckBoolOf(jResp,"audits[i].events[j].sedb2")
nostrud_fd6 = CkJsonObject::ckStringOf(jResp,"audits[i].events[j].nostrud_fd6")
ullamcoe = CkJsonObject::ckStringOf(jResp,"audits[i].events[j].ullamcoe")
adipisicing_1 = CkJsonObject::ckBoolOf(jResp,"audits[i].events[j].adipisicing_1")
j = j + 1
Wend
i = i + 1
Wend
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
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}"
}
]
}
