Scores

Silktide 4 and Silktide 5 each give a website scores out of 100, but they work them out differently, so the same website gets different numbers from each. The API keeps them apart: each edition has its own scores operations, and each one names its edition.

Which to call#

Call the operations for the edition of Silktide your account uses. An account that has only one edition is refused the other's operations with an EditionNotAvailable error, which names the operation to call instead:

{
  "error": {
    "type": "EditionNotAvailable",
    "message": "This account does not have Silktide 4, so it cannot use /v1/results/scores. Use /v1/results/module-scores instead.",
    "properties": { "edition": 4, "instead": "/v1/results/module-scores" },
    "status": 403
  }
}

Like other results errors, it comes back with status 200 and the error's own status inside it. See Results.

An account that has both editions can call both. If you are moving from Silktide 4 to Silktide 5, keep reading Silktide 4's scores until you have switched, and expect the numbers in your own reports to change on the day you do.

How the ids match#

Where a Silktide 4 score has a Silktide 5 counterpart, it measures the same thing. The numbers still differ, because the two editions test and weigh pages differently. Do not join the two series into one line.

Silktide 5 has no overall score. Each module stands on its own.

Reports, report schedules and report templates are Silktide 4's too. An account with only Silktide 5 gets a 403 with an EditionNotAvailable error from them.

Most other operations, such as websites, checks and content, work for both editions. Each operation's page says which editions it works for.