Skip to content
Menu
SilktideDevelopers

Results

How the operations under /v1/results/ answer, which website they are about, and which dates.

View as Markdown

Scores, checks and the other things Silktide finds are read through the operations under /v1/results/. They share their arguments and the shape of their answer.

The answer#

Every results operation answers with the same three fields:

{
  "result": { "scores": { "overall": 80.8 } },
  "selector": "/v1/results/scores",
  "duration": 0.009
}
FieldWhat it is
resultThe answer. Its shape is on each operation's page.
selectorWhich results query answered.
durationHow many seconds Silktide took.

Check for error first#

A results query that fails while answering, because an argument is missing or has a value it does not accept, still answers with status 200, with an error in place of result:

{
  "error": {
    "type": "InvalidContext",
    "message": "No website specified or available.",
    "properties": []
  }
}

So check the body for error before you read result. Each operation's page lists these errors with the status 200.

Which website#

websiteId says which website the results are for. sectionId narrows them to one of its sections; left out, it is 0, the whole website. See Websites and sections.

Which dates#

Results that keep history take a period:

periodCovers
allEverything. The default.
todayToday.
last-7-days, last-30-days, last-90-daysThe whole days before today. Today is not included.
month-to-date, year-to-dateSince the start of this month or year, up to now.
last-monthThe whole of last month.
last-12-monthsThe twelve whole months before this one. This month is not included.
customFrom from to to, both days such as 2026-10-01.

Days start and end at midnight in timezone, an IANA name such as America/New_York. It defaults to UTC.

The spaced names from older versions of these docs, such as -7 days and month to date, still work.