List a website's checks and how each is doing

GET/v1/results/checks

Returns every check a website or one of its sections is tested with, and where each stands now: open or done, how many issues, its score.

Filter by confidence to see only what is certain (error) or only what needs a person to look (review). checkType is the older filter and still works; confidence wins when both are sent.

Use a check's id with Get check for its history.

Request

curl "https://api.eu.silktide.com/v1/results/checks?websiteId=3" \
  -H "Authorization: silktide token=$SILKTIDE_API_KEY"

Response: Every check on a website

{
  "result": {
    "checks": [
      {
        "checkId": "broken-links",
        "checkerId": "Links/BrokenLinks",
        "name": "Check and fix broken links",
        "subName": "",
        "shortName": "Broken links",
        "policyId": 0,
        "checkType": "auto",
        "confidence": "error",
        "status": "open",
        "severity": 77.625,
        "opened": 1790224865,
        "closed": 0,
        "numIssues": 4,
        "score": 82.5
      },
      {
        "checkId": "accessibility-overlay",
        "checkerId": "Accessibility/AccessibilityOverlay",
        "name": "Avoid relying on a third-party accessibility overlay",
        "subName": "",
        "shortName": "Accessibility overlay",
        "policyId": 0,
        "checkType": "",
        "confidence": "error",
        "status": "done",
        "severity": 0,
        "opened": 0,
        "closed": 0,
        "numIssues": 0,
        "score": 100
      }
    ]
  },
  "selector": "/v1/results/checks",
  "duration": 0.04
}

Request

Query parameters

websiteIdintegerrequiredat least 1
The website.
sectionIdinteger
A section of the website. Defaults to 0, the whole website.
confidencestring
Only checks of these confidences, comma-separated: error, warning, review.
checkTypestring
Only checks of these older types, comma-separated: auto or assist. Ignored when confidence is sent.
isPolicystring
1 for only checks from policies, 0 for only Silktide's own. Left out, both.
One of01

Response

200JSON.

resultobjectrequired
The answer.
Show 1 fieldsHide fields
- checkslist of objectsrequired
  Every check the website or section is tested with.
  Show 14 fieldsHide fields
  - checkIdstringrequired
    The check's id, such as broken-links. Use it with Get check.
  - checkerIdstringrequired
    The internal name of the code that runs the check, such as Links/BrokenLinks.
  - namestringrequired
    What the check asks for, in the API user's language.
  - subNamestringrequired
    The standard it tests against, such as WCAG 2.0 A 1.3.1. Can be empty.
  - shortNamestringrequired
    A short name for the check.
  - policyIdintegerrequired
    The policy the check comes from, or 0 for Silktide's own checks.
  - checkTypestringrequired
    The older classification: auto (automatic), assist (needs a person's judgment), info, or empty.
  - confidencestringrequired
    How sure Silktide is of an issue: error, warning or review. Can be info or empty for older checks.
  - statusstringrequired
    open when it has something to fix, done when it does not.
    One ofopendone
  - severitynumberrequired0 to 100
    How much its issues matter, from 0 to 100.
  - openedintegerrequired
    When it was opened. 0 if it never was.
  - closedintegerrequired
    When it was closed. 0 if it is not.
  - numIssuesintegerrequired
    How many issues it found.
  - scorenumberrequiredcan be null0 to 100
    Its score out of 100. Null when it cannot be scored.
selectorstringrequired
The query that answered, as its path: /v1/results/scores.
durationnumberrequired
Seconds Silktide took to answer.

Errors

Status	Type	When
404	`ModelNotFound`	No website or section with that id exists in the account, or the API key's user cannot see it.
200	`InvalidContext`	No `websiteId` was sent. The body is an error despite the status.
401	`NotLoggedIn`	No API key was sent, or it is not a key for this region.(any operation)
429	`TooManyRequests`	Too many requests to this path in five seconds. Retry after the number of seconds in the `Retry-After` header, which `properties.retryAfter` repeats.(any operation)
503	-	Silktide is busy. Retry after the number of seconds in the `Retry-After` header.(any operation)

Every error has the same body. See Errors.

Access

Permission: Any user of the account
Plan feature: None
Edition: Silktide 4 and Silktide 5
Cost: Free
Available since: v1.0.0

Try it

Sends a real request to your account from this browser. Your key stays in this tab and goes only to the Silktide API.

Request

curl "https://api.eu.silktide.com/v1/results/checks?websiteId=3" \
  -H "Authorization: silktide token=$SILKTIDE_API_KEY"

Response: Every check on a website

{
  "result": {
    "checks": [
      {
        "checkId": "broken-links",
        "checkerId": "Links/BrokenLinks",
        "name": "Check and fix broken links",
        "subName": "",
        "shortName": "Broken links",
        "policyId": 0,
        "checkType": "auto",
        "confidence": "error",
        "status": "open",
        "severity": 77.625,
        "opened": 1790224865,
        "closed": 0,
        "numIssues": 4,
        "score": 82.5
      },
      {
        "checkId": "accessibility-overlay",
        "checkerId": "Accessibility/AccessibilityOverlay",
        "name": "Avoid relying on a third-party accessibility overlay",
        "subName": "",
        "shortName": "Accessibility overlay",
        "policyId": 0,
        "checkType": "",
        "confidence": "error",
        "status": "done",
        "severity": 0,
        "opened": 0,
        "closed": 0,
        "numIssues": 0,
        "score": 100
      }
    ]
  },
  "selector": "/v1/results/checks",
  "duration": 0.04
}

Try it

Sends a real request to your account from this browser. Your key stays in this tab and goes only to the Silktide API.