Chilkat Online Tools

Node.js / Atlassian Confluence Cloud / Export audit records

Back to Collection Items

var os = require('os');
if (os.platform() == 'win32') {  
    if (os.arch() == 'ia32') {
        var chilkat = require('@chilkat/ck-node21-win-ia32');
    } else {
        var chilkat = require('@chilkat/ck-node21-win64'); 
    }
} else if (os.platform() == 'linux') {
    if (os.arch() == 'arm') {
        var chilkat = require('@chilkat/ck-node21-arm');
    } else if (os.arch() == 'x86') {
        var chilkat = require('@chilkat/ck-node21-linux32');
    } else {
        var chilkat = require('@chilkat/ck-node21-linux64');
    }
} else if (os.platform() == 'darwin') {
    if (os.arch() == 'arm64') {
        var chilkat = require('@chilkat/ck-node21-mac-m1');
    } else {
        var chilkat = require('@chilkat/ck-node21-macosx');
    }
}


function chilkatExample() {

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

    var http = new chilkat.Http();
    var success;

    var queryParams = new chilkat.JsonObject();
    queryParams.UpdateString("startDate","<string>");
    queryParams.UpdateString("endDate","<string>");
    queryParams.UpdateString("searchString","<string>");
    queryParams.UpdateString("format","csv");

    // resp: HttpResponse
    var resp = http.QuickRequestParams("GET","https://your-domain.atlassian.net/wiki/rest/api/audit/export",queryParams);
    if (http.LastMethodSuccess == false) {
        console.log(http.LastErrorText);
        return;
    }

    success = resp.SaveBodyBinary("response.zip");
    if (success == false) {
        console.log(resp.LastErrorText);
        console.log("Failed to save the response body to the filesystem.");
    }


}

chilkatExample();

Curl Command

curl -G -d "startDate=%3Cstring%3E"
	-d "endDate=%3Cstring%3E"
	-d "searchString=%3Cstring%3E"
	-d "format=csv"
	-o "response.zip"
https://your-domain.atlassian.net/wiki/rest/api/audit/export

Postman Collection Item JSON

{
  "name": "Export audit records",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{baseUrl}}/api/audit/export?startDate=<string>&endDate=<string>&searchString=<string>&format=csv",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "audit",
        "export"
      ],
      "query": [
        {
          "key": "startDate",
          "value": "<string>",
          "description": "Filters the exported 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 exported 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 exported results to records that have string property values\nmatching the `searchString`."
        },
        {
          "key": "format",
          "value": "csv",
          "description": "The format of the export file for the audit records."
        }
      ]
    },
    "description": "Exports audit records as a CSV file or ZIP file.\n\n**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:\n'Confluence Administrator' global permission."
  },
  "response": [
    {
      "name": "Returned if the requested export of the audit records is returned.",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/api/audit/export?startDate=<string>&endDate=<string>&searchString=<string>&format=csv",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "audit",
            "export"
          ],
          "query": [
            {
              "key": "startDate",
              "value": "<string>"
            },
            {
              "key": "endDate",
              "value": "<string>"
            },
            {
              "key": "searchString",
              "value": "<string>"
            },
            {
              "key": "format",
              "value": "csv"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/zip"
        }
      ],
      "cookie": [
      ],
      "body": "nostrud officia proident"
    },
    {
      "name": "Returned if the calling user does not have permission to view the audit\nlog.",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/api/audit/export?startDate=<string>&endDate=<string>&searchString=<string>&format=csv",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "audit",
            "export"
          ],
          "query": [
            {
              "key": "startDate",
              "value": "<string>"
            },
            {
              "key": "endDate",
              "value": "<string>"
            },
            {
              "key": "searchString",
              "value": "<string>"
            },
            {
              "key": "format",
              "value": "csv"
            }
          ]
        }
      },
      "status": "Forbidden",
      "code": 403,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}