Export audit log

Starting the job

This operation is a long-running batch job. You must first submit a request to start the job.

POST https://www.activityinfo.org/resources/jobs

Request body

object
type	string	The type of the job to start. Must be `"exportAuditLog"`	required
descriptor	object		required
databaseId	string		required
auditRequest	object		required
resourceFilter	string	The id of a form, folder, or report. If provided, the result will only include events that relate to this resource.	optional
typeFilter	array[string]	Only include events of the given types. Values: RECORD Any addition, modification, or deletion of a form record. FORM The addition, renaming, or deletion of a form. REPORT The addition, renaming or deletion of a report. FOLDER The addition, renaming or deletion of a folder DATABASE The renaming of a database. LOCK The addition, modification, or deletion of a record lock. USER_PERMISSION Any change to a user's permissions. ROLE Addition, modification, or deletion of a role. AUTOMATION Addition, modification, or deletion of an automation.	required
startTime	integer	The start time of the request, in milliseconds since the unix epoch. The results will include the first 100 - 150 events that occurred before this time.	required
endTime	instant	The end time of the request, in milliseconds since the unix epoch. The results will include the events that occurred after the end time and before the start time.	optional
fileFormat	string	Values: XLSX Office Open XML .xlsx file. DOCX Office Open XML .docx file. PDF Adobe Portable Document Format (PDF) CSV Comma-separated Values, as a UTF-8 encoded text file. SQLITE Sqlite database compatible with the ActivityInfo standalone server TEXT UTF-8 encoded text file, with rows seperated by newline characters ('\n') and columns seperated by the INFORMATION SEPARATOR control character (U+001F). Can only be used for a single form, or for database forms exported using the LONG format. NDJSON UTF-8 encoded newline-delimited JSON, where each row is separated by the newline character ('\n'), and each line is a valid JSON value. Only used for the audit log	required
utcOffset	integer	The time zone to use for time values, as an offset from Universal Coordinate Time (UTC) in minutes,	required

Getting the job status

The result of this first call provides a job id that you can use to poll for status:

GET https://www.activityinfo.org/resources/jobs/{jobId}

curl -X GET https://www.activityinfo.org/resources/jobs/ahBlfmFjdGl2aXR5aW5mb2V1chALEgNKb2IYgICAzd390wkM \
  -u anything:APITOKEN \
  -H 'Content-type: application/json' \
  --data-binary @- << EOF
{
  "id": "ahBlfmFjdGl2aXR5aW5mb2V1chALEgNKb2IYgICAzd390wkM",
  "state": "STARTED"
}
EOF

Successful result

When the job state transitions to "COMPLETED", the status object will include the result:

object
id	string	The id of the job	required
state	string	`"COMPLETED"`	required
result	object		required
filename	string	The filename of the export.	required
downloadUrl	string	The URL that can be used to download the result.	required

Next item

Export billing account stats