C / Support API / List Audits for a Ticket
Back to Collection Items
#include <C_CkHttp.h>
#include <C_CkStringBuilder.h>
#include <C_CkJsonObject.h>
void ChilkatSample(void)
{
HCkHttp http;
BOOL success;
HCkStringBuilder sbResponseBody;
HCkJsonObject jResp;
int respStatusCode;
const char *author_id;
const char *created_at;
const char *id;
const char *Fugiat2_;
BOOL Aliqua4f;
const char *ticket_id;
const char *Channel;
const char *Amet29d;
const char *Aliqua_b0;
const char *Amet_24;
int Non_b8;
int In_3a;
int Occaecat_d98;
BOOL Commodo_60e;
int j;
int count_j;
const char *in14;
BOOL consequat_b9;
int Lorem4;
const char *incididunt_a;
int ipsume1;
const char *laboris_8c;
BOOL consectetur6;
BOOL officia1;
BOOL minim_27;
const char *Ut7_2;
const char *count;
const char *next_page;
const char *previous_page;
int i;
int count_i;
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http = CkHttp_Create();
CkHttp_putBasicAuth(http,TRUE);
CkHttp_putLogin(http,"login");
CkHttp_putPassword(http,"password");
CkHttp_SetRequestHeader(http,"Accept","application/json");
sbResponseBody = CkStringBuilder_Create();
success = CkHttp_QuickGetSb(http,"https://example.zendesk.com/api/v2/tickets/:ticket_id/audits",sbResponseBody);
if (success == FALSE) {
printf("%s\n",CkHttp_lastErrorText(http));
CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponseBody);
return;
}
jResp = CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,FALSE);
printf("Response Body:\n");
printf("%s\n",CkJsonObject_emit(jResp));
respStatusCode = CkHttp_getLastStatus(http);
printf("Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
printf("Response Header:\n");
printf("%s\n",CkHttp_lastHeader(http));
printf("Failed.\n");
CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
return;
}
// 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
// Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.
count = CkJsonObject_stringOf(jResp,"count");
next_page = CkJsonObject_stringOf(jResp,"next_page");
previous_page = CkJsonObject_stringOf(jResp,"previous_page");
i = 0;
count_i = CkJsonObject_SizeOfArray(jResp,"audits");
while (i < count_i) {
CkJsonObject_putI(jResp,i);
author_id = CkJsonObject_stringOf(jResp,"audits[i].author_id");
created_at = CkJsonObject_stringOf(jResp,"audits[i].created_at");
id = CkJsonObject_stringOf(jResp,"audits[i].id");
Fugiat2_ = CkJsonObject_stringOf(jResp,"audits[i].metadata.fugiat2_");
Aliqua4f = CkJsonObject_BoolOf(jResp,"audits[i].metadata.aliqua4f");
ticket_id = CkJsonObject_stringOf(jResp,"audits[i].ticket_id");
Channel = CkJsonObject_stringOf(jResp,"audits[i].via.channel");
Amet29d = CkJsonObject_stringOf(jResp,"audits[i].via.source.amet29d");
Aliqua_b0 = CkJsonObject_stringOf(jResp,"audits[i].via.source.aliqua_b0");
Amet_24 = CkJsonObject_stringOf(jResp,"audits[i].via.source.amet_24");
Non_b8 = CkJsonObject_IntOf(jResp,"audits[i].via.source.non_b8");
In_3a = CkJsonObject_IntOf(jResp,"audits[i].metadata.in_3a");
Occaecat_d98 = CkJsonObject_IntOf(jResp,"audits[i].metadata.occaecat_d98");
Commodo_60e = CkJsonObject_BoolOf(jResp,"audits[i].via.source.commodo_60e");
j = 0;
count_j = CkJsonObject_SizeOfArray(jResp,"audits[i].events");
while (j < count_j) {
CkJsonObject_putJ(jResp,j);
in14 = CkJsonObject_stringOf(jResp,"audits[i].events[j].in14");
consequat_b9 = CkJsonObject_BoolOf(jResp,"audits[i].events[j].consequat_b9");
Lorem4 = CkJsonObject_IntOf(jResp,"audits[i].events[j].Lorem4");
incididunt_a = CkJsonObject_stringOf(jResp,"audits[i].events[j].incididunt_a");
ipsume1 = CkJsonObject_IntOf(jResp,"audits[i].events[j].ipsume1");
laboris_8c = CkJsonObject_stringOf(jResp,"audits[i].events[j].laboris_8c");
consectetur6 = CkJsonObject_BoolOf(jResp,"audits[i].events[j].consectetur6");
officia1 = CkJsonObject_BoolOf(jResp,"audits[i].events[j].officia1");
minim_27 = CkJsonObject_BoolOf(jResp,"audits[i].events[j].minim_27");
Ut7_2 = CkJsonObject_stringOf(jResp,"audits[i].events[j].Ut7_2");
j = j + 1;
}
i = i + 1;
}
CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(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}"
}
]
}
