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.

Path parameters

id string required

Audit run id.

Responses

The audit run.

id string required

userId string 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.

orgId any

url string (uri) required

status string required

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

model any

healthScore any

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

issuesFound any

issuesFixed any

reportId any

websiteId any

auditId any

config any

error any

completionReason any

completionMessage any

costUsd any

startedAt any

completedAt any

createdAt string (date-time) required

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

{
  "id": "<string>",
  "userId": "<string>",
  "orgId": {},
  "url": "<url>",
  "status": "pending",
  "trigger": "cli",
  "mode": "audit",
  "model": {},
  "healthScore": {},
  "issuesFound": {},
  "issuesFixed": {},
  "reportId": {},
  "websiteId": {},
  "auditId": {},
  "config": {},
  "error": {},
  "completionReason": {},
  "completionMessage": {},
  "costUsd": {},
  "startedAt": {},
  "completedAt": {},
  "createdAt": "2023-11-07T05:31:56Z"
}

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

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

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

Edit this page