/auditlogs/exports – Alida Help Center

Resource URL

/v2/applications/{communityApiKeyName}/auditlogs/exports

Note: You must use a regional endpoint when making requests to this endpoint. For details about the available region endpoints, see Shared responsibility.

Available Methods

Method	Description
1. POST	Starts a new Event Log export job.
2. GET	Returns the status of each Event Log export job within the last 7 days.

Available fields for 1. POST

Element	Description
`id`	A string GUID of the export job.

Example

{
    "id": <GUID of the export job>
}

Parameters for 1. POST

If you want to select the delimiter for the export .CSV file, you can specify it as a parameter.

Note: Set the Content-Type header as application/json to prevent any errors that can occur.

Parameter Description

delimiter

Optional. The delimiter to use to separate values in the .CSV export file. The supported values are:

comma
pipe
semicolon
tab

Comma delimited is the default value, and is used if a delimiter is not specified.

type Optional. csv is the only option, and is used if the type is not specified.

Example POST body

{
    "delimiter": "comma",
    "type": "csv"	
}

Available fields for 2. GET

Element	Description
`createdate`	The date and time in UTC when the export was created.
`data`	The URL to use to retrieve the temporary link used to download the export file.
`errormessage`	Null, unless the `status` is "Failed". For failed jobs the error message returned by the endpoint is listed.
`filename`	The filename of the export file.
`id`	The unique identifier for the export job.
`status`	The string name for the job status. Possible values include: `Succeeded` - The export job succeeded and the event log file is ready for download. `Failed` - The export job failed. `Queued` - The export job has not started yet. `Executing` - The export job is in progress.

2. GET response structure

{
  "meta": {
    "offset": 0,
    "limit": -1,
    "count": 3
  },
  "items": [
    {
      "id": "{JobId}",
      "status": "Succeeded",
      "errormessage": "null",
      "data": "<URL to retrieve download link from>",
      "createdate": "2021-07-01T21:18:32.227Z",
      "filename": "<filename>"
    },
    {
      "id": "{JobId}",
      "status": "Queued",
      "errormessage": "null",
      "data": "null",
      "createdate": "2021-07-011T21:18:32.227Z",
      "filename": "<filename>"
    },
    {
      "id": "{JobId}",
      "status": "Failed",
      "errormessage": "<error message>",
      "data": "",
      "createdate": "2021-07-01T21:18:32.227Z",
      "filename": "<filename>"
    }
  ]
}