Sign in
latestOpenAPI 3.0.3GitGuardian2026-08-201871515.0 MB

511b067cdcb1

Scans

Get a scan's audit summary

⚠️ Beta endpoint: behavior and schemas are subject to change.

Return the audit summary for a scan. Always 200 when the scan and its audit row exist — the summary's summary_status tells you whether the data is final (done), still being computed (pending), or failed (failed).

get/v1/scans/{scan_id}/audit

Path parameters

scan_idstring uuid required
Example:3635820f-0dad-4d1e-95aa-4b0aac1aa231

The id of the scan to retrieve the audit summary for.

Response

Scan Audit Summary

summary_status'pending' | 'done' | 'failed' required

Whether this summary has finished being computed.

monitoring_type'historical' | 'recurrent' | 'realtime' required
duration_secondsinteger nullable

Duration of the scan, in seconds.

pending_secondsinteger nullable

Time the scan spent pending before it started, in seconds.

elements_scannedinteger nullable
elements_skippedinteger nullable
elements_failedinteger nullable
data_downloaded_bytesinteger nullable
data_scanned_bytesinteger nullable
secrets_by_severityobject required

Number of secrets found, grouped by severity.

outcome_by_reasonobject required

Per-category breakdown of skipped/failed element counts, grouped by reason. Internal engine/infra failure reasons are never exposed individually — they are collapsed into a single internal_error key.

ended_atstring date-time required

When the scan ended.

rolled_up_atstring date-time nullable

When the rollup completed. Null while summary_status is pending.

Example response

{
  "summary_status": "done",
  "monitoring_type": "historical",
  "duration_seconds": 42,
  "pending_seconds": 5,
  "elements_scanned": 1523,
  "elements_skipped": 12,
  "data_downloaded_bytes": 10485760,
  "data_scanned_bytes": 8388608,
  "secrets_by_severity": {
    "critical": 1,
    "high": 2
  },
  "outcome_by_reason": {
    "skipped": {
      "unsupported_extension": 3
    },
    "failed": {
      "internal_error": 1
    }
  },
  "ended_at": "2024-06-01T10:00:00Z",
  "rolled_up_at": "2024-06-01T10:05:00Z"
}