API referenceReports

Export the audit trail

Every audited action in the period, for an auditor to hold. **Attempts as well as successes.** `succeeded` is a column, not a filter: a trail that records only what worked answers "what did we do" and not "what was attempted", and an investigation starts from the second. **Oldest first**, unlike the activity screen. Somebody reading an export is reconstructing a sequence; the newest-first order that suits a dashboard makes that read backwards. Actors are named, not just identified — the file is joined to the user rather than leaving an auditor to resolve UUIDs from a second export. System and API-key actions keep their place, with no name.

POST
/api/b/v1/reports/audit/export

Every audited action in the period, for an auditor to hold.

Attempts as well as successes. succeeded is a column, not a filter: a trail that records only what worked answers "what did we do" and not "what was attempted", and an investigation starts from the second.

Oldest first, unlike the activity screen. Somebody reading an export is reconstructing a sequence; the newest-first order that suits a dashboard makes that read backwards.

Actors are named, not just identified — the file is joined to the user rather than leaving an auditor to resolve UUIDs from a second export. System and API-key actions keep their place, with no name.

Authorization

OAuth2PasswordBearer
AuthorizationBearer <token>

In: header

admin_access_token?string|null

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

A report over a window of time.

Response Body

application/json

application/json

curl -X POST "https://example.com/api/b/v1/reports/audit/export" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "kind": "string",  "format": "string",  "status": "string",  "filename": "string",  "row_count": 0,  "byte_size": 0,  "error": "string",  "expires_at": "2019-08-24T14:15:22Z",  "created_at": "2019-08-24T14:15:22Z"}