Skip to main content
POST
/
v1
/
knowledge-base
/
audit
/
exports
Request an async encrypted KB audit export
curl --request POST \
  --url https://api-sandbox.featherhq.com/v1/knowledge-base/audit/exports \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "start": "2023-11-07T05:31:56Z",
  "end": "2023-11-07T05:31:56Z",
  "export_format": "csv",
  "kb_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "statuses": [
    "<string>"
  ],
  "actor_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "<string>",
  "export_format": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "window_start": "2023-11-07T05:31:56Z",
  "window_end": "2023-11-07T05:31:56Z",
  "started_at": "2023-11-07T05:31:56Z",
  "finalized_at": "2023-11-07T05:31:56Z",
  "expires_at": "2023-11-07T05:31:56Z",
  "total_rows": 123,
  "partial_count": 123,
  "failed_count": 123,
  "error_code": "<string>",
  "filters": {},
  "files": []
}

Authorizations

​
x-api-key
string
header
required

Body

application/json

POST body for an async encrypted audit export.

​
start
string<date-time>
required
​
end
string<date-time>
required
​
export_format
enum<string>
default:csv
Available options:
csv,
ndjson
​
kb_ids
string<uuid>[] | null
​
statuses
string[] | null
​
actor_user_id
string<uuid> | null
​
session_id
string<uuid> | null

Response

Successful Response

Status view of an export job (with per-file download tokens when ready).

​
id
string<uuid>
required
​
status
string
required
​
export_format
string
required
​
created_at
string<date-time>
required
​
window_start
string<date-time> | null
​
window_end
string<date-time> | null
​
started_at
string<date-time> | null
​
finalized_at
string<date-time> | null
​
expires_at
string<date-time> | null
​
total_rows
integer | null
​
partial_count
integer | null
​
failed_count
integer | null
​
error_code
string | null
​
filters
Filters · object
​
files
ExportFileStatus · object[]