Get a report

Fetch report metadata

GET/v1/reports/{id}

Fetch report metadata. Public and unlisted reports are readable without auth; private reports require a bearer token belonging to the owner (a non-owner gets 404, never revealing existence).

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path parameters

idstringrequired

Report id.

Responses

Report metadata.

idstringrequired

baseUrlstring (uri)required

healthScoreany

pageCountany

errorCountany

warningCountany

passedCountany

visibility"public" | "unlisted" | "private"required

Available options: public, unlisted, private

viewCountany

auditedAtany

createdAtstring (date-time)required

urlstring (uri)required

curl --request GET \
  --url "https://api.squirrelscan.com/v1/reports/ID" \
  --header "Authorization: Bearer YOUR_API_KEY"

const res = await fetch("https://api.squirrelscan.com/v1/reports/ID", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY"
  },
});
const data = await res.json();

import requests

headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}

r = requests.get("https://api.squirrelscan.com/v1/reports/ID", headers=headers)
r.raise_for_status()
data = r.json()

{
  "id": "<string>",
  "baseUrl": "<url>",
  "healthScore": {},
  "pageCount": {},
  "errorCount": {},
  "warningCount": {},
  "passedCount": {},
  "visibility": "public",
  "viewCount": {},
  "auditedAt": {},
  "createdAt": "2023-11-07T05:31:56Z",
  "url": "<url>"
}

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

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

Edit this page