Get one check and its history

GET/v1/results/check

Returns one check on a website or section: where it stands now, the same as in Get checks, and every past measurement of its score and issue count.

The last entry in history is the latest measurement again, timed at the moment you asked, so a chart drawn from it runs up to now. Ignore it if you only want real measurements.

history always covers the check's whole history; this query takes no period.

A checkId the website is not tested with is an error, but it comes back with status 200 and an error body of type ModelNotFound. Check for error before reading result.

Request

curl "https://api.eu.silktide.com/v1/results/check?checkId=broken-links&websiteId=3" \
  -H "Authorization: silktide token=$SILKTIDE_API_KEY"

Response: Broken links on a website

{
  "result": {
    "check": {
      "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
    },
    "history": [
      {
        "time": 1790215200,
        "score": 82.608696,
        "numIssues": 8
      },
      {
        "time": 1790820000,
        "score": 82.5,
        "numIssues": 4
      }
    ]
  },
  "selector": "/v1/results/check",
  "duration": 0.006
}

Request

Query parameters

checkIdstringrequired
The check, by the id Get checks returns.
websiteIdintegerrequiredat least 1
The website.
sectionIdinteger
A section of the website. Defaults to 0, the whole website.

Response

200JSON.

resultobjectrequired
The answer.
Show 2 fieldsHide fields
- checkobjectrequired
  The check now.
  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.
- historylist of objectsrequired
  Each measurement of the check. The last entry repeats the latest one, timed when you asked.
  Show 3 fieldsHide fields
  - timeintegerrequired
    When it was measured.
  - scorenumberrequiredcan be null0 to 100
    Its score then.
  - numIssuesintegerrequired
    Its issues then.
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.
200	`InvalidArgument`	`checkId` is missing. The body is an error despite the status.
200	`ModelNotFound`	The website or section is not tested with that check. 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/check?checkId=broken-links&websiteId=3" \
  -H "Authorization: silktide token=$SILKTIDE_API_KEY"

Response: Broken links on a website

{
  "result": {
    "check": {
      "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
    },
    "history": [
      {
        "time": 1790215200,
        "score": 82.608696,
        "numIssues": 8
      },
      {
        "time": 1790820000,
        "score": 82.5,
        "numIssues": 4
      }
    ]
  },
  "selector": "/v1/results/check",
  "duration": 0.006
}

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.