Chilkat Online Tools

VB.NET / Support API / List Audit Logs

Back to Collection Items

' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.

Dim http As New Chilkat.Http
Dim success As Boolean

http.BasicAuth = True
http.Login = "login"
http.Password = "password"

Dim queryParams As New Chilkat.JsonObject
queryParams.UpdateString("filter[source_type]","<string>")
queryParams.UpdateString("filter[source_id]","<integer>")
queryParams.UpdateString("filter[actor_id]","<integer>")
queryParams.UpdateString("filter[ip_address]","<string>")
queryParams.UpdateString("filter[created_at]","<string>")
queryParams.UpdateString("filter[action]","<string>")
queryParams.UpdateString("sort_by","<string>")
queryParams.UpdateString("sort_order","<string>")
queryParams.UpdateString("sort","<string>")

http.SetRequestHeader("Accept","application/json")


Dim resp As Chilkat.HttpResponse = http.QuickRequestParams("GET","https://example.zendesk.com/api/v2/audit_logs",queryParams)
If (http.LastMethodSuccess = False) Then
    Debug.WriteLine(http.LastErrorText)
    Exit Sub
End If


Dim sbResponseBody As New Chilkat.StringBuilder
resp.GetBodySb(sbResponseBody)

Dim jResp As New Chilkat.JsonObject
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

Debug.WriteLine("Response Body:")
Debug.WriteLine(jResp.Emit())

Dim respStatusCode As Integer = resp.StatusCode
Debug.WriteLine("Response Status Code = " & respStatusCode)
If (respStatusCode >= 400) Then
    Debug.WriteLine("Response Header:")
    Debug.WriteLine(resp.Header)
    Debug.WriteLine("Failed.")

    Exit Sub
End If



' 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



Dim action As String
Dim action_label As String
Dim actor_id As String
Dim actor_name As String
Dim change_description As String
Dim created_at As String
Dim id As String
Dim ip_address As String
Dim source_id As String
Dim source_label As String
Dim source_type As String
Dim url As String

Dim i As Integer = 0
Dim count_i As Integer = jResp.SizeOfArray("audit_logs")
While i < count_i
    jResp.I = i
    action = jResp.StringOf("audit_logs[i].action")
    action_label = jResp.StringOf("audit_logs[i].action_label")
    actor_id = jResp.StringOf("audit_logs[i].actor_id")
    actor_name = jResp.StringOf("audit_logs[i].actor_name")
    change_description = jResp.StringOf("audit_logs[i].change_description")
    created_at = jResp.StringOf("audit_logs[i].created_at")
    id = jResp.StringOf("audit_logs[i].id")
    ip_address = jResp.StringOf("audit_logs[i].ip_address")
    source_id = jResp.StringOf("audit_logs[i].source_id")
    source_label = jResp.StringOf("audit_logs[i].source_label")
    source_type = jResp.StringOf("audit_logs[i].source_type")
    url = jResp.StringOf("audit_logs[i].url")
    i = i + 1
End While

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}"
    }
  ]
}