List the pages and documents one check found issues on

GET/v1/results/check-contents

Lists the pages and documents of a website or section that one check tested, with the check's score and issue count on each, most issues first. By default it lists only those with issues: send issues=all for everything the check tested, or issues=withoutIssues for what passed.

Each row is a page or document as Get contents returns it, plus score and numIssues. Content the check cannot score, such as a PDF for a check that reads only web pages, has a score of null and no issues, so issues=all and issues=withoutIssues list it too.

Get the checkId from Get checks. A checkId that names no check answers with no rows, not an error. Leave out websiteId to list content from every website the API key's user can see.

This query takes page and rowsPerPage (see Pagination) but none of the table arguments: columns, sort and search are ignored.

A missing checkId, or a page or rowsPerPage that is not a whole number of at least 1, is an InvalidRequest error whose properties.field names the argument. It comes with status 200, like every results error, so check for error before reading result.

Request

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

Response: The pages with the most spelling issues

{
  "result": {
    "contents": {
      "page": 1,
      "minPage": 1,
      "maxPage": 23,
      "numRows": 45,
      "rowsPerPage": 2,
      "rows": [
        {
          "acId": "901b49430261ea9c0241f4712b7dc06e",
          "url": "https://fakewinebarrel.com/one-more/",
          "title": "An article about wine - Wine Barrel",
          "contentType": "html",
          "httpCode": 200,
          "mimeType": "text/html",
          "downloaded": 1791424695,
          "discovered": 1790223072,
          "defaultOrder": "202-036-036",
          "flowId": 0,
          "stepNo": 0,
          "isFailedStep": false,
          "score": 0,
          "numIssues": 71
        },
        {
          "acId": "0106ed17299002688a08a0f794aa8eae",
          "url": "https://fakewinebarrel.com/wines-are-confusing/",
          "title": "Wines: easily confused with hamburgers - Wine Barrel",
          "contentType": "html",
          "httpCode": 200,
          "mimeType": "text/html",
          "downloaded": 1791424671,
          "discovered": 1790223215,
          "defaultOrder": "202-047-047",
          "flowId": 0,
          "stepNo": 0,
          "isFailedStep": false,
          "score": 12.5,
          "numIssues": 9
        }
      ]
    }
  },
  "selector": "/v1/results/check-contents",
  "duration": 0.012
}

Request

Query parameters

checkIdstringrequired
The check, by the id Get checks returns.
issuesstring
withIssues for content the check found issues on, withoutIssues for content it found none on, all for both. Defaults to withIssues. Any other value means all.
One ofwithIssueswithoutIssuesall
websiteIdintegerat least 1
The website. Left out, every website the API key's user can see.
sectionIdinteger
With websiteId, a section of the website. Defaults to 0, the whole website.
pageintegerat least 1
The page of rows to return, from 1. Defaults to 1.
rowsPerPageintegerat least 1
How many rows a page holds. Defaults to 100. Must be at least 1.

Response

200JSON.

resultobjectrequired
The answer.
Show 1 fieldsHide fields
- contentsobjectrequired
  One page of the content the check tested, most issues first.
  Show 6 fieldsHide fields
  - pageintegerrequiredat least 1
    The page returned. A page past the last returns the last, so this is not always the page asked for.
  - minPageintegerrequiredat least 1
    The first page. Always 1.
  - maxPageintegerrequiredat least 1
    The last page at this rowsPerPage. 1 when there are no rows.
  - numRowsintegerrequired
    How many rows there are across every page.
  - rowsPerPageintegerrequiredat least 1
    How many rows a page holds.
  - rowslist of objectsrequired
    The rows on this page.
    Show 14 fieldsHide fields
    acIdstringrequired
    Its id in the account. It stays the same while the website and URL do.
    urlstringrequired
    Its URL. A document linked from the website can be on another domain.
    titlestringrequired
    Its title: a page's <title>, or a document's title or file name. Untitled when a document has neither.
    contentTypestringrequired
    What it is: html for a page, pdf for a PDF document. Silktide tests no other kind today.
    One ofhtmlpdftextwordexcelpowerpointother
    httpCodeintegerrequiredcan be null
    The HTTP status it answered with when last downloaded. Null when none was recorded.
    mimeTypestringrequired
    Its content type as the server sent it, such as text/html.
    downloadedintegerrequired
    When Silktide last downloaded it.
    discoveredintegerrequired
    When Silktide first downloaded it.
    defaultOrderstringrequired
    Sort by this, ascending, to list content in the order Silktide does. Its format can change; only compare it.
    flowIdintegerrequired
    The user flow it was reached by, or 0 when it was crawled.
    stepNointegerrequired
    In a user flow, its step, from 0. 0 when it was crawled.
    isFailedStepbooleanrequired
    True when it is the step at which its user flow failed.
    scorenumberrequiredcan be null0 to 100
    The check's score on this page or document, out of 100. Null when the check cannot score it.
    numIssuesintegerrequired
    How many issues the check found on it.
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	`InvalidRequest`	`checkId` is missing. The error's own `status` is `400` and `properties.field` is `checkId`. The body is an error despite the status.
200	`InvalidRequest`	`page` is not a whole number of at least `1`. The error's own `status` is `400` and `properties.field` is `page`. The body is an error despite the status.
200	`InvalidRequest`	`rowsPerPage` is not a whole number of at least `1`. The error's own `status` is `400` and `properties.field` is `rowsPerPage`. 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-contents?checkId=spelling&websiteId=3&rowsPerPage=2" \
  -H "Authorization: silktide token=$SILKTIDE_API_KEY"

Response: The pages with the most spelling issues

{
  "result": {
    "contents": {
      "page": 1,
      "minPage": 1,
      "maxPage": 23,
      "numRows": 45,
      "rowsPerPage": 2,
      "rows": [
        {
          "acId": "901b49430261ea9c0241f4712b7dc06e",
          "url": "https://fakewinebarrel.com/one-more/",
          "title": "An article about wine - Wine Barrel",
          "contentType": "html",
          "httpCode": 200,
          "mimeType": "text/html",
          "downloaded": 1791424695,
          "discovered": 1790223072,
          "defaultOrder": "202-036-036",
          "flowId": 0,
          "stepNo": 0,
          "isFailedStep": false,
          "score": 0,
          "numIssues": 71
        },
        {
          "acId": "0106ed17299002688a08a0f794aa8eae",
          "url": "https://fakewinebarrel.com/wines-are-confusing/",
          "title": "Wines: easily confused with hamburgers - Wine Barrel",
          "contentType": "html",
          "httpCode": 200,
          "mimeType": "text/html",
          "downloaded": 1791424671,
          "discovered": 1790223215,
          "defaultOrder": "202-047-047",
          "flowId": 0,
          "stepNo": 0,
          "isFailedStep": false,
          "score": 12.5,
          "numIssues": 9
        }
      ]
    }
  },
  "selector": "/v1/results/check-contents",
  "duration": 0.012
}

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.