Governance
Add and test websites, then read their scores and checks for accessibility, content quality, SEO and more.
Governance tests websites. It crawls each one, checks every page and document against hundreds of checks for accessibility, content, SEO, privacy and more, and scores the results.
Through the API you can keep the websites Silktide tests in step with your own list, start tests, and read the results into your own dashboards, tickets and reports. New to it? Follow Add a website and read its scores from start to finish.
In Silktide itself: Governance, in Help.
Websites
- GETList websites and their sections
/v1/websitesReturns every website the API key's user can see, one entry per section. - GETGet a website's settings
/v1/websites/{websiteId}Returns one website: its details, who may do what with it, when it is retested, and its settings. - POSTCreate a website
/v1/websitesCreates a website and, unless you say otherwise, starts testing it straight away. - PUTUpdate a website
/v1/websites/{websiteId}Changes a website. - POSTTest a website now
/v1/websites/{websiteId}/testStarts a test. - DELDelete a website and everything in it
/v1/websites/{websiteId}Deletes a website at once, with its sections, results and history. - GETGet headline statistics for every website
/v1/websites/statsReturns the headline statistics of every live website in one call: scores, issue counts, page counts and the technology Silktide found.
Scores
- GETGet 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. - GETGet how a Silktide 4 score changed over time
/v1/results/score-trendReturns every measurement of one Silktide 4 score in the period, oldest first, for a website or one of its sections. - GETGet a website's Silktide 5 scores
/v1/results/module-scoresReturns a website's scores as Silktide 5 works them out: one for each module, and its WCAG conformance at each version and level. - GETGet how a Silktide 5 score changed over time
/v1/results/module-score-trendReturns every measurement of one Silktide 5 score in the period, oldest first, for a website or one of its sections.
Checks
- GETList a website's checks and how each is doing
/v1/results/checksReturns every check a website or one of its sections is tested with, and where each stands now: open or done, how many issues, its score. - GETGet one check and its history
/v1/results/checkReturns one check on a website or section: where it stands now, the same as in Get checks, and every past measurement of its score and issue count. - GETList the pages and documents one check found issues on
/v1/results/check-contentsLists the pages and documents of a website or section that one check tested, with the check's score and issue count on each, most issues first.
Content
Metadata
- GETGet a section's metadata, and the properties it can have
/v1/websites/{websiteId}/sections/{sectionId}/metaReturns a section's metadata values, and every metadata property the account defines, so you can show the empty ones too. - POSTSet some of a section's metadata
/v1/websites/{websiteId}/sections/{sectionId}/metaSets some of a section's metadata values and returns all of them, as Get a section's metadata does.
Reports
- GETList reports
/v1/reportsReturns every report the API key's user can see, with no paging. - GETGet a report
/v1/reports/{reportId}Returns one report, as List reports lists it. - GETGet what a report shows
/v1/reports/{reportId}/resultsReturns what a report shows: the template it is built from, the template's widgets, and each widget's results under its widgetId. - POSTCreate a live report or a snapshot
/v1/reportsCreates a report from a report template, and builds it. - PUTRename a report, or change what a live report covers
/v1/reports/{reportId}Changes a report. - DELDelete a report
/v1/reports/{reportId}Deletes a report and its results at once.
Report schedules
- GETList report schedules
/v1/report-schedulesReturns every report schedule the API key's user can see, with no paging. - GETGet a report schedule and who it emails
/v1/report-schedules/{reportScheduleId}Returns one report schedule and who it emails. - POSTCreate a report schedule
/v1/report-schedulesCreates a report schedule: on each run it makes a snapshot from a report template and emails it to its subscribers. - PUTUpdate a report schedule or who it emails
/v1/report-schedules/{reportScheduleId}Changes a report schedule, who it emails, or both. - DELDelete a report schedule
/v1/report-schedules/{reportScheduleId}Deletes a report schedule at once, so it makes no more snapshots and sends no more emails.