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 ChilkatHttp
Dim success As Long
Dim queryParams As New ChilkatJsonObject
success = queryParams.UpdateString("startDate","<string>")
success = queryParams.UpdateString("endDate","<string>")
success = queryParams.UpdateString("searchString","<string>")
success = queryParams.UpdateInt("start",0)
success = queryParams.UpdateInt("limit",1000)
Dim resp As ChilkatHttpResponse
Set resp = http.QuickRequestParams("GET","https://your-domain.atlassian.net/wiki/rest/api/audit",queryParams)
If (http.LastMethodSuccess = 0) Then
Debug.Print http.LastErrorText
Exit Sub
End If
Dim sbResponseBody As New ChilkatStringBuilder
success = resp.GetBodySb(sbResponseBody)
Dim jResp As New ChilkatJsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = 0
Debug.Print "Response Body:"
Debug.Print jResp.Emit()
Dim respStatusCode As Long
respStatusCode = resp.StatusCode
Debug.Print "Response Status Code = " & respStatusCode
If (respStatusCode >= 400) Then
Debug.Print "Response Header:"
Debug.Print resp.Header
Debug.Print "Failed."
Exit Sub
End If
' Sample JSON response:
' (Sample code for parsing the JSON response is shown below)
' {
' "results": [
' {
' "author": {
' "type": "user",
' "displayName": "ut qui occaecat",
' "operations": null,
' "username": "officia dolor",
' "userKey": "Ut Lorem"
' },
' "remoteAddress": "ullamco tempor id",
' "creationDate": 87607791,
' "summary": "ut laboris qui Ut",
' "description": "pariatur ut cillum id quis",
' "category": "pariatur et sunt enim dolor",
' "sysAdmin": true,
' "affectedObject": {
' "name": "pariatur ea eu",
' "objectType": "exerci"
' },
' "changedValues": [
' {
' "name": "voluptate Lorem nostrud",
' "oldValue": "exercitation dolor",
' "newValue": "nulla proident"
' },
' {
' "name": "proid",
' "oldValue": "sint eu",
' "newValue": "sed adipisicing irure"
' }
' ],
' "associatedObjects": [
' {
' "name": "eiusmod aliquip incididunt",
' "objectType": "laboris aute elit tempor"
' },
' {
' "name": "dolore adipisicing",
' "objectType": "eiusmod cillum sunt Ut cupidatat"
' }
' ]
' },
' {
' "author": {
' "type": "user",
' "displayName": "deserunt laboris voluptate cupidatat",
' "operations": null,
' "username": "et cillum ut cupidatat",
' "userKey": "qui magna eu deserunt"
' },
' "remoteAddress": "v",
' "creationDate": 42657177,
' "summary": "enim sit dolore cillum",
' "description": "Excepteur sit",
' "category": "exercitation in ea",
' "sysAdmin": true,
' "affectedObject": {
' "name": "ex cillum",
' "objectType": "eu officia veniam labore"
' },
' "changedValues": [
' {
' "name": "dolor laborum sed do sunt",
' "oldValue": "dolor eiusmod",
' "newValue": "nulla"
' },
' {
' "name": "consectetur eiusmod",
' "oldValue": "Except",
' "newValue": "culpa aliquip"
' }
' ],
' "associatedObjects": [
' {
' "name": "adipisicing aliquip",
' "objectType": "elit Ut laboris"
' },
' {
' "name": "anim",
' "objectType": "dolore in voluptate"
' }
' ]
' }
' ],
' "start": 48713254,
' "limit": 16739977,
' "size": -39928545,
' "_links": {}
' }
' Sample code for parsing the JSON response...
' Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Dim v_Type As String
Dim DisplayName As String
Dim Operations As String
Dim Username As String
Dim UserKey As String
Dim remoteAddress As String
Dim creationDate As Long
Dim summary As String
Dim description As String
Dim category As String
Dim sysAdmin As Long
Dim Name As String
Dim ObjectType As String
Dim j As Long
Dim count_j As Long
Dim name As String
Dim oldValue As String
Dim newValue As String
Dim objectType As String
Dim start As Long
start = jResp.IntOf("start")
Dim limit As Long
limit = jResp.IntOf("limit")
Dim size As Long
size = jResp.IntOf("size")
Dim i As Long
i = 0
Dim count_i As Long
count_i = jResp.SizeOfArray("results")
Do While i < count_i
jResp.I = i
v_Type = jResp.StringOf("results[i].author.type")
DisplayName = jResp.StringOf("results[i].author.displayName")
Operations = jResp.StringOf("results[i].author.operations")
Username = jResp.StringOf("results[i].author.username")
UserKey = jResp.StringOf("results[i].author.userKey")
remoteAddress = jResp.StringOf("results[i].remoteAddress")
creationDate = jResp.IntOf("results[i].creationDate")
summary = jResp.StringOf("results[i].summary")
description = jResp.StringOf("results[i].description")
category = jResp.StringOf("results[i].category")
sysAdmin = jResp.BoolOf("results[i].sysAdmin")
Name = jResp.StringOf("results[i].affectedObject.name")
ObjectType = jResp.StringOf("results[i].affectedObject.objectType")
j = 0
count_j = jResp.SizeOfArray("results[i].changedValues")
Do While j < count_j
jResp.J = j
name = jResp.StringOf("results[i].changedValues[j].name")
oldValue = jResp.StringOf("results[i].changedValues[j].oldValue")
newValue = jResp.StringOf("results[i].changedValues[j].newValue")
j = j + 1
Loop
j = 0
count_j = jResp.SizeOfArray("results[i].associatedObjects")
Do While j < count_j
jResp.J = j
name = jResp.StringOf("results[i].associatedObjects[j].name")
objectType = jResp.StringOf("results[i].associatedObjects[j].objectType")
j = j + 1
Loop
i = i + 1
Loop
Curl Command
curl -G -d "startDate=%3Cstring%3E"
-d "endDate=%3Cstring%3E"
-d "searchString=%3Cstring%3E"
-d "start=0"
-d "limit=1000"
https://your-domain.atlassian.net/wiki/rest/api/audit
Postman Collection Item JSON
{
"name": "Get audit records",
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/api/audit?startDate=<string>&endDate=<string>&searchString=<string>&start=0&limit=1000",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"audit"
],
"query": [
{
"key": "startDate",
"value": "<string>",
"description": "Filters the results to the records on or after the `startDate`.\nThe `startDate` must be specified as a [timestamp](https://www.unixtimestamp.com/)."
},
{
"key": "endDate",
"value": "<string>",
"description": "Filters the results to the records on or before the `endDate`.\nThe `endDate` must be specified as a [timestamp](https://www.unixtimestamp.com/)."
},
{
"key": "searchString",
"value": "<string>",
"description": "Filters the results to records that have string property values\nmatching the `searchString`."
},
{
"key": "start",
"value": "0",
"description": "The starting index of the returned records."
},
{
"key": "limit",
"value": "1000",
"description": "The maximum number of records to return per page.\nNote, this may be restricted by fixed system limits."
}
]
},
"description": "Returns all records in the audit log, optionally for a certain date range.\nThis contains information about events like space exports, group membership\nchanges, app installations, etc. For more information, see\n[Audit log](https://confluence.atlassian.com/confcloud/audit-log-802164269.html)\nin the Confluence administrator's guide.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\n'Confluence Administrator' global permission."
},
"response": [
{
"name": "Returned if the requested records are returned.",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/api/audit?startDate=<string>&endDate=<string>&searchString=<string>&start=0&limit=1000",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"audit"
],
"query": [
{
"key": "startDate",
"value": "<string>"
},
{
"key": "endDate",
"value": "<string>"
},
{
"key": "searchString",
"value": "<string>"
},
{
"key": "start",
"value": "0"
},
{
"key": "limit",
"value": "1000"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"results\": [\n {\n \"author\": {\n \"type\": \"user\",\n \"displayName\": \"ut qui occaecat\",\n \"operations\": null,\n \"username\": \"officia dolor\",\n \"userKey\": \"Ut Lorem\"\n },\n \"remoteAddress\": \"ullamco tempor id\",\n \"creationDate\": 87607791,\n \"summary\": \"ut laboris qui Ut\",\n \"description\": \"pariatur ut cillum id quis\",\n \"category\": \"pariatur et sunt enim dolor\",\n \"sysAdmin\": true,\n \"affectedObject\": {\n \"name\": \"pariatur ea eu\",\n \"objectType\": \"exerci\"\n },\n \"changedValues\": [\n {\n \"name\": \"voluptate Lorem nostrud\",\n \"oldValue\": \"exercitation dolor\",\n \"newValue\": \"nulla proident\"\n },\n {\n \"name\": \"proid\",\n \"oldValue\": \"sint eu\",\n \"newValue\": \"sed adipisicing irure\"\n }\n ],\n \"associatedObjects\": [\n {\n \"name\": \"eiusmod aliquip incididunt\",\n \"objectType\": \"laboris aute elit tempor\"\n },\n {\n \"name\": \"dolore adipisicing\",\n \"objectType\": \"eiusmod cillum sunt Ut cupidatat\"\n }\n ]\n },\n {\n \"author\": {\n \"type\": \"user\",\n \"displayName\": \"deserunt laboris voluptate cupidatat\",\n \"operations\": null,\n \"username\": \"et cillum ut cupidatat\",\n \"userKey\": \"qui magna eu deserunt\"\n },\n \"remoteAddress\": \"v\",\n \"creationDate\": 42657177,\n \"summary\": \"enim sit dolore cillum\",\n \"description\": \"Excepteur sit\",\n \"category\": \"exercitation in ea\",\n \"sysAdmin\": true,\n \"affectedObject\": {\n \"name\": \"ex cillum\",\n \"objectType\": \"eu officia veniam labore\"\n },\n \"changedValues\": [\n {\n \"name\": \"dolor laborum sed do sunt\",\n \"oldValue\": \"dolor eiusmod\",\n \"newValue\": \"nulla\"\n },\n {\n \"name\": \"consectetur eiusmod\",\n \"oldValue\": \"Except\",\n \"newValue\": \"culpa aliquip\"\n }\n ],\n \"associatedObjects\": [\n {\n \"name\": \"adipisicing aliquip\",\n \"objectType\": \"elit Ut laboris\"\n },\n {\n \"name\": \"anim\",\n \"objectType\": \"dolore in voluptate\"\n }\n ]\n }\n ],\n \"start\": 48713254,\n \"limit\": 16739977,\n \"size\": -39928545,\n \"_links\": {}\n}"
},
{
"name": "Returned if the calling user does not have permission to view the audit\nlog.",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/api/audit?startDate=<string>&endDate=<string>&searchString=<string>&start=0&limit=1000",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"audit"
],
"query": [
{
"key": "startDate",
"value": "<string>"
},
{
"key": "endDate",
"value": "<string>"
},
{
"key": "searchString",
"value": "<string>"
},
{
"key": "start",
"value": "0"
},
{
"key": "limit",
"value": "1000"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}
