Get an audit run

Fetch a single audit run

GET/v1/agent-runs/{id}

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).

Path parameters

idstringrequired

Audit run id.

Responses

The audit run.

idstringrequired

urlstring (uri)required

statusstringrequired

Available options: pending, running, completed, failed, cancelled

trigger"cli" | "api" | "github" | "scheduled"required

Available options: cli, api, github, scheduled

mode"audit" | "audit-fix" | "fix" | "recommend"required

Available options: audit, audit-fix, fix, recommend

modelany

healthScoreany

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`.

issuesFoundany

issuesFixedany

reportIdany

websiteIdany

auditIdany

configany

errorany

completionReasonany

completionMessageany

costUsdany

startedAtany

completedAtany

createdAtstring (date-time)required

userIdstringrequired

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.

orgIdany

progressany

Live progress while `status` is `pending`/`running` (#692): the latest phase/page-count event streamed by the run. Null once the run is terminal, or if no progress event has been recorded yet.

noticeobject

Present only when the run's requested page count exceeded the org's plan ceiling. The run is never rejected for this (clamp-and-notify, not a hard error) — it dispatches at `applied` pages instead of `requested`, and this field says so.

curl --request GET \
  --url "https://api.squirrelscan.com/v1/agent-runs/ID"

const res = await fetch("https://api.squirrelscan.com/v1/agent-runs/ID", {
  method: "GET",
});
const data = await res.json();

import requests


r = requests.get("https://api.squirrelscan.com/v1/agent-runs/ID")
r.raise_for_status()
data = r.json()

{}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>"
  }
}

Edit this page