unicodeC / Support API / List Audit Logs
Back to Collection Items
#include <C_CkHttpW.h>
#include <C_CkJsonObjectW.h>
#include <C_CkHttpResponseW.h>
#include <C_CkStringBuilderW.h>
void ChilkatSample(void)
{
HCkHttpW http;
BOOL success;
HCkJsonObjectW queryParams;
HCkHttpResponseW resp;
HCkStringBuilderW sbResponseBody;
HCkJsonObjectW jResp;
int respStatusCode;
const wchar_t *action;
const wchar_t *action_label;
const wchar_t *actor_id;
const wchar_t *actor_name;
const wchar_t *change_description;
const wchar_t *created_at;
const wchar_t *id;
const wchar_t *ip_address;
const wchar_t *source_id;
const wchar_t *source_label;
const wchar_t *source_type;
const wchar_t *url;
int i;
int count_i;
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http = CkHttpW_Create();
CkHttpW_putBasicAuth(http,TRUE);
CkHttpW_putLogin(http,L"login");
CkHttpW_putPassword(http,L"password");
queryParams = CkJsonObjectW_Create();
CkJsonObjectW_UpdateString(queryParams,L"filter[source_type]",L"<string>");
CkJsonObjectW_UpdateString(queryParams,L"filter[source_id]",L"<integer>");
CkJsonObjectW_UpdateString(queryParams,L"filter[actor_id]",L"<integer>");
CkJsonObjectW_UpdateString(queryParams,L"filter[ip_address]",L"<string>");
CkJsonObjectW_UpdateString(queryParams,L"filter[created_at]",L"<string>");
CkJsonObjectW_UpdateString(queryParams,L"filter[action]",L"<string>");
CkJsonObjectW_UpdateString(queryParams,L"sort_by",L"<string>");
CkJsonObjectW_UpdateString(queryParams,L"sort_order",L"<string>");
CkJsonObjectW_UpdateString(queryParams,L"sort",L"<string>");
CkHttpW_SetRequestHeader(http,L"Accept",L"application/json");
resp = CkHttpW_QuickRequestParams(http,L"GET",L"https://example.zendesk.com/api/v2/audit_logs",queryParams);
if (CkHttpW_getLastMethodSuccess(http) == FALSE) {
wprintf(L"%s\n",CkHttpW_lastErrorText(http));
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(queryParams);
return;
}
sbResponseBody = CkStringBuilderW_Create();
CkHttpResponseW_GetBodySb(resp,sbResponseBody);
jResp = CkJsonObjectW_Create();
CkJsonObjectW_LoadSb(jResp,sbResponseBody);
CkJsonObjectW_putEmitCompact(jResp,FALSE);
wprintf(L"Response Body:\n");
wprintf(L"%s\n",CkJsonObjectW_emit(jResp));
respStatusCode = CkHttpResponseW_getStatusCode(resp);
wprintf(L"Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
wprintf(L"Response Header:\n");
wprintf(L"%s\n",CkHttpResponseW_header(resp));
wprintf(L"Failed.\n");
CkHttpResponseW_Dispose(resp);
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(queryParams);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_Dispose(jResp);
return;
}
CkHttpResponseW_Dispose(resp);
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "audit_logs": [
// {
// "action": "<string>",
// "action_label": "<string>",
// "actor_id": "<integer>",
// "actor_name": "<string>",
// "change_description": "<string>",
// "created_at": "<dateTime>",
// "id": "<integer>",
// "ip_address": "<string>",
// "source_id": "<integer>",
// "source_label": "<string>",
// "source_type": "<string>",
// "url": "<string>"
// },
// {
// "action": "<string>",
// "action_label": "<string>",
// "actor_id": "<integer>",
// "actor_name": "<string>",
// "change_description": "<string>",
// "created_at": "<dateTime>",
// "id": "<integer>",
// "ip_address": "<string>",
// "source_id": "<integer>",
// "source_label": "<string>",
// "source_type": "<string>",
// "url": "<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.
i = 0;
count_i = CkJsonObjectW_SizeOfArray(jResp,L"audit_logs");
while (i < count_i) {
CkJsonObjectW_putI(jResp,i);
action = CkJsonObjectW_stringOf(jResp,L"audit_logs[i].action");
action_label = CkJsonObjectW_stringOf(jResp,L"audit_logs[i].action_label");
actor_id = CkJsonObjectW_stringOf(jResp,L"audit_logs[i].actor_id");
actor_name = CkJsonObjectW_stringOf(jResp,L"audit_logs[i].actor_name");
change_description = CkJsonObjectW_stringOf(jResp,L"audit_logs[i].change_description");
created_at = CkJsonObjectW_stringOf(jResp,L"audit_logs[i].created_at");
id = CkJsonObjectW_stringOf(jResp,L"audit_logs[i].id");
ip_address = CkJsonObjectW_stringOf(jResp,L"audit_logs[i].ip_address");
source_id = CkJsonObjectW_stringOf(jResp,L"audit_logs[i].source_id");
source_label = CkJsonObjectW_stringOf(jResp,L"audit_logs[i].source_label");
source_type = CkJsonObjectW_stringOf(jResp,L"audit_logs[i].source_type");
url = CkJsonObjectW_stringOf(jResp,L"audit_logs[i].url");
i = i + 1;
}
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(queryParams);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_Dispose(jResp);
}
Curl Command
curl -u login:password -G -d "filter[source_type]=%3Cstring%3E"
-d "filter[source_id]=%3Cinteger%3E"
-d "filter[actor_id]=%3Cinteger%3E"
-d "filter[ip_address]=%3Cstring%3E"
-d "filter[created_at]=%3Cstring%3E"
-d "filter[action]=%3Cstring%3E"
-d "sort_by=%3Cstring%3E"
-d "sort_order=%3Cstring%3E"
-d "sort=%3Cstring%3E"
-H "Accept: application/json"
https://example.zendesk.com/api/v2/audit_logs
Postman Collection Item JSON
{
"name": "List Audit Logs",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/audit_logs?filter[source_type]=<string>&filter[source_id]=<integer>&filter[actor_id]=<integer>&filter[ip_address]=<string>&filter[created_at]=<string>&filter[action]=<string>&sort_by=<string>&sort_order=<string>&sort=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"audit_logs"
],
"query": [
{
"key": "filter[source_type]",
"value": "<string>",
"description": "Filter audit logs by the source type. For example, user or rule"
},
{
"key": "filter[source_id]",
"value": "<integer>",
"description": "Filter audit logs by the source id. Requires `filter[source_type]` to also be set."
},
{
"key": "filter[actor_id]",
"value": "<integer>",
"description": "Filter audit logs by the actor id"
},
{
"key": "filter[ip_address]",
"value": "<string>",
"description": "Filter audit logs by the ip address"
},
{
"key": "filter[created_at]",
"value": "<string>",
"description": "Filter audit logs by the time of creation"
},
{
"key": "filter[action]",
"value": "<string>",
"description": "Filter audit logs by the action"
},
{
"key": "sort_by",
"value": "<string>",
"description": "Offset pagination only. Sort audit logs. Default is `sort_by=created_at`"
},
{
"key": "sort_order",
"value": "<string>",
"description": "Offset pagination only. Sort audit logs. Default is `sort_order=desc`"
},
{
"key": "sort",
"value": "<string>",
"description": "Cursor pagination only. Sort audit logs. Default is `sort=-created_at`"
}
]
},
"description": "#### Allowed For\n\n* Admins on accounts that have audit log access\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"
},
"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/audit_logs?filter[source_type]=<string>&filter[source_id]=<integer>&filter[actor_id]=<integer>&filter[ip_address]=<string>&filter[created_at]=<string>&filter[action]=<string>&sort_by=<string>&sort_order=<string>&sort=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"audit_logs"
],
"query": [
{
"key": "filter[source_type]",
"value": "<string>",
"description": "Filter audit logs by the source type. For example, user or rule"
},
{
"key": "filter[source_id]",
"value": "<integer>",
"description": "Filter audit logs by the source id. Requires `filter[source_type]` to also be set."
},
{
"key": "filter[actor_id]",
"value": "<integer>",
"description": "Filter audit logs by the actor id"
},
{
"key": "filter[ip_address]",
"value": "<string>",
"description": "Filter audit logs by the ip address"
},
{
"key": "filter[created_at]",
"value": "<string>",
"description": "Filter audit logs by the time of creation"
},
{
"key": "filter[action]",
"value": "<string>",
"description": "Filter audit logs by the action"
},
{
"key": "sort_by",
"value": "<string>",
"description": "Offset pagination only. Sort audit logs. Default is `sort_by=created_at`"
},
{
"key": "sort_order",
"value": "<string>",
"description": "Offset pagination only. Sort audit logs. Default is `sort_order=desc`"
},
{
"key": "sort",
"value": "<string>",
"description": "Cursor pagination only. Sort audit logs. Default is `sort=-created_at`"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"audit_logs\": [\n {\n \"action\": \"<string>\",\n \"action_label\": \"<string>\",\n \"actor_id\": \"<integer>\",\n \"actor_name\": \"<string>\",\n \"change_description\": \"<string>\",\n \"created_at\": \"<dateTime>\",\n \"id\": \"<integer>\",\n \"ip_address\": \"<string>\",\n \"source_id\": \"<integer>\",\n \"source_label\": \"<string>\",\n \"source_type\": \"<string>\",\n \"url\": \"<string>\"\n },\n {\n \"action\": \"<string>\",\n \"action_label\": \"<string>\",\n \"actor_id\": \"<integer>\",\n \"actor_name\": \"<string>\",\n \"change_description\": \"<string>\",\n \"created_at\": \"<dateTime>\",\n \"id\": \"<integer>\",\n \"ip_address\": \"<string>\",\n \"source_id\": \"<integer>\",\n \"source_label\": \"<string>\",\n \"source_type\": \"<string>\",\n \"url\": \"<string>\"\n }\n ]\n}"
}
]
}
