Skip to Content
API ReferenceAudit Logs

Audit Logs

Read-only access to the workspace’s audit log — every API request recorded against the workspace, with actor, action, resource, and outcome. Useful for compliance review and debugging who did what.

Base URL

https://api.voxburst.io/v1/audit-logs

Authentication: Requires the audit-logs:read scope. This is a read-only group — there is no audit-logs:write scope, and any non-GET request returns 403. Rate limited to 30 requests/minute.


List Audit Logs

GET /v1/audit-logs

Query Parameters

ParameterTypeDescription
resourceTypestringFilter by resource type, e.g. "posts"
actionstringFilter by action: "create", "update", "delete"
actorIdstringFilter by actor (user ID)
actorTypestringFilter by actor type: "user", "api_key", "system"
startDate / endDatestringISO 8601 date range
cursorstringOpaque pagination cursor
limitnumber1–100, default 50
formatstring"json" (default) or "csv"
curl "https://api.voxburst.io/v1/audit-logs?resourceType=posts&action=create&limit=20" \ -H "Authorization: Bearer vb_live_xxxxxxxxxxxxx"

Response (JSON)

{ "data": [ { "id": "log_abc123", "timestamp": "2026-08-30T12:00:00.000Z", "actorType": "api_key", "actorId": null, "apiKeyId": "key_abc123", "action": "create", "resourceType": "posts", "resourceId": "post_abc123", "method": "POST", "path": "/v1/posts", "statusCode": 201, "ipAddress": "203.0.113.4", "userAgent": "curl/8.4.0", "requestId": "req_xyz789" } ], "pagination": { "has_more": false, "next_cursor": null, "limit": 20 } }

CSV Export

Pass format=csv to receive a CSV file instead, with Content-Disposition: attachment:

curl "https://api.voxburst.io/v1/audit-logs?format=csv&startDate=2026-08-01T00:00:00Z" \ -H "Authorization: Bearer vb_live_xxxxxxxxxxxxx" \ -o audit-logs.csv

Audit Log Statistics

GET /v1/audit-logs/stats

Returns summary counts, useful for a dashboard widget.

Query Parameters

ParameterTypeDescription
startDate / endDatestringISO 8601 date range
curl "https://api.voxburst.io/v1/audit-logs/stats" \ -H "Authorization: Bearer vb_live_xxxxxxxxxxxxx"

Response

{ "data": { "total": 4213, "byAction": { "create": 1890, "update": 2100, "delete": 223 }, "byResourceType": { "posts": 3400, "accounts": 500, "webhooks": 313 } } }

Get a Single Audit Log Entry

GET /v1/audit-logs/:id

curl https://api.voxburst.io/v1/audit-logs/log_abc123 \ -H "Authorization: Bearer vb_live_xxxxxxxxxxxxx"

Error Codes

StatusCause
404Audit log entry not found in this workspace
Last updated on