Run every check and return a single 0 to 100 score

Runs all checks, then weights findings into one score, a letter grade and a tone of good, warn or bad. Powers the embeddable badge at /badge.svg.

get/api/score

Request

  • Base URL: https://api.shipwork.io
  • URL: https://api.shipwork.io/api/score
  • Auth: none declared

Query parameters

urlstring uri required

Absolute http or https URL to check.

Response

Score, grade, tone, per-check breakdown and summary counts

scoreinteger
grade'A' | 'B' | 'C' | 'D' | 'F'
tone'good' | 'warn' | 'bad'
breakdownobject
summaryobject

Changes

No recorded changes to this operation across all 1 revision of this API.