Skip to content

Audit API

DRAFT — Internal Developer Use Only

This API reference is for internal development teams.

Overview

What it is: The audit API provides access to audit logs, metrics, and dashboard views for tracking platform activity and compliance.

Endpoints

MethodPathDescriptionAuth required
GET/internal/v1/audit/logsList audit log entriesJWT + API token
GET/internal/v1/audit/metricsGet audit metrics summaryJWT + API token
GET/internal/v1/audit/metrics/chartGet audit metrics chart dataJWT + API token
GET/internal/v1/audit/dashboardGet audit dashboard overviewJWT + API token

GET /internal/v1/audit/logs

List audit log entries with optional filtering.

Request:

http
GET /internal/v1/audit/logs?from=2026-02-01&to=2026-02-12&action=login
Authorization: Bearer <token>

Response (200):

json
{
  "logs": [
    {
      "timestamp": "2026-02-12T09:15:00Z",
      "action": "login",
      "userId": "user-uuid",
      "ip": "10.0.1.50",
      "result": "success"
    }
  ],
  "totalCount": 245
}

GET /internal/v1/audit/metrics

Get a summary of audit metrics.

Request:

http
GET /internal/v1/audit/metrics
Authorization: Bearer <token>

Response (200):

json
{
  "totalEvents": 15420,
  "byAction": {
    "login": 5200,
    "collection": 8100,
    "configuration": 2120
  },
  "period": "last-30-days"
}

Hydden Documentation and Training Hub