Audits

Get an audit run

Fetch full detail for a single audit run owned by the authenticated user. While status is pending/running, progress carries the latest phase/page-count event streamed by the run, when one has been recorded. notice carries a page_limit_clamped signal when the run's requested page count was clamped down to the org's plan ceiling at dispatch time (never a hard error — the run itself still completed normally). renderFallback carries a render_fallback signal, with the page count, when pages that asked for rendering were audited from their unrendered source instead.

get/v1/agent-runs/{id}

Request

  • Base URL: https://api.squirrelscan.com
  • URL: https://api.squirrelscan.com/v1/agent-runs/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Audit run id.

Response

The audit run.

idstring required
urlstring uri required
status'pending' | 'running' | 'completed' | 'failed' | 'cancelled' required
trigger'cli' | 'api' | 'github' | 'scheduled' required
mode'audit' | 'audit-fix' | 'fix' | 'recommend' required
modelstring nullable
healthScoreinteger nullable

Rounded score from the persisted health_score DB column (an integer). The unrounded float is available as report.healthScore on GET /v1/agent-runs/{id}/report.

issuesFoundinteger nullable
issuesFixedinteger nullable
reportIdstring nullable
websiteIdstring nullable
auditIdstring nullable
configobject nullable
errorstring nullable
completionReasonstring nullable
completionMessagestring nullable
costUsdnumber nullable
startedAtstring date-time nullable
completedAtstring date-time nullable
createdAtstring date-time required
userIdstring required

Internal owner user id (the caller's own — runs are scoped to the authenticated user). Treat as an opaque identifier; do not log/forward outside an authenticated context.

orgIdstring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.