Skip to content
Menu
SilktideDevelopers

Get a website's Silktide 4 scores

GET/v1/results/scores
View as Markdown

Returns every Silktide 4 score of a website or one of its sections, each as its latest value in the period. With no period, that is the latest score there is.

This is for accounts that have Silktide 4. An account that has only Silktide 5 gets an EditionNotAvailable error; it reads Get a website's Silktide 5 scores instead. Scores explains which to use.

Scores are out of 100 and keep one decimal place. Older documentation said they were whole numbers; read them as numbers either way. A score Silktide cannot work out for this website, such as PDF accessibility on a website with no PDFs, is null.

Websites do not all have the same scores, so read them by id. Use an id with Get how a Silktide 4 score changed to see how it changed.

Request
curl "https://api.eu.silktide.com/v1/results/scores?websiteId=2" \
  -H "Authorization: silktide token=$SILKTIDE_API_KEY"
Response: A website's latest Silktide 4 scores
{
  "result": {
    "scores": {
      "content": 70.1,
      "mobile": 100,
      "overall": 80.8,
      "wcag-22-aa": 97.8,
      "wcag-22-pdf": null
    }
  },
  "selector": "/v1/results/scores",
  "duration": 0.009
}

Request

Query parameters

  • websiteIdintegerrequiredat least 1

    The website.

  • sectionIdinteger

    A section of the website. Defaults to 0, the whole website.

  • periodstring

    The date range. Defaults to all. The spaced forms (-7 days, month to date) are older names that keep working. custom needs from and to.

    One ofalltodaylast-7-dayslast-30-dayslast-90-daysmonth-to-datelast-monthyear-to-datelast-12-monthscustom-7 days-30 days-90 days-1 monthmonth to dateyear to date-12 months

  • fromstring

    With period=custom, the first day, such as 2026-10-01.

  • tostring

    With period=custom, the last day.

  • timezonestring

    The IANA time zone days are read in, such as America/New_York. Defaults to UTC.

Response

200JSON.

  • resultobjectrequired

    The answer.

    Show 1 fields
    • scoresmap of numbersrequired

      Each score by id, such as overall or wcag-22-aa, out of 100 to one decimal place. Null when it cannot be scored.

  • selectorstringrequired

    The query that answered, as its path: /v1/results/scores.

  • durationnumberrequired

    Seconds Silktide took to answer.

Errors

StatusTypeWhen
404ModelNotFoundNo website or section with that id exists in the account, or the API key's user cannot see it.
200InvalidContextNo websiteId was sent. The body is an error despite the status.
200InvalidArgumentperiod is not one of its values. The body is an error despite the status.
200EditionNotAvailableThe account does not have Silktide 4. Its status is 403, and instead names /v1/results/module-scores. The body is an error despite the status.
401NotLoggedInNo API key was sent, or it is not a key for this region.(any operation)
429TooManyRequestsToo 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 only
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.