Get a website's Silktide 4 scores
/v1/results/scoresReturns 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.
curl "https://api.eu.silktide.com/v1/results/scores?websiteId=2" \
-H "Authorization: silktide token=$SILKTIDE_API_KEY"{
"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 1The website.
sectionIdintegerA section of the website. Defaults to
0, the whole website.periodstringThe date range. Defaults to
all. The spaced forms (-7 days,month to date) are older names that keep working.customneedsfromandto.One of
alltodaylast-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 monthsfromstringWith
period=custom, the first day, such as2026-10-01.tostringWith
period=custom, the last day.timezonestringThe IANA time zone days are read in, such as
America/New_York. Defaults toUTC.
Response
200JSON.
resultobjectrequiredThe answer.
Show 1 fieldsHide fields
scoresmap of numbersrequiredEach score by id, such as
overallorwcag-22-aa, out of 100 to one decimal place. Null when it cannot be scored.
selectorstringrequiredThe query that answered, as its path:
/v1/results/scores.durationnumberrequiredSeconds 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 | period is not one of its values. The body is an error despite the status. |
| 200 | EditionNotAvailable | The 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. |
| 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 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.