# Silktide Developers

> Build on Silktide with its REST API: add and test websites, read accessibility, content and SEO results, and manage your account from your own code.

Every page is also Markdown: add `.md` to its URL, or send `Accept: text/markdown`. Authenticate with `Authorization: silktide token=YOUR_API_KEY` against your account's region: https://api.eu.silktide.com, https://api.us.silktide.com or https://api.au.silktide.com.

Working in a project with a coding agent? Paste the snippet in [Build with a coding agent](https://developers.silktide.com/guides/build-with-a-coding-agent.md) into its AGENTS.md or CLAUDE.md.

## Get started

- [Quickstart](https://developers.silktide.com/guides/quickstart.md): Create an API key, find your account's region, and make your first request in five minutes.
- [Authentication](https://developers.silktide.com/guides/authentication.md): Send your API key in the Authorization header, to your account's own region.
- [Add a website and read its scores](https://developers.silktide.com/guides/add-a-website.md): Check your balance, create a website, wait for its first test, then read its scores.
- [What the API is for](https://developers.silktide.com/guides/what-the-api-is-for.md): What the Silktide API lets your developers build, in plain language, for people who will not write the code.
- [Set up a website before its first test](https://developers.silktide.com/guides/set-up-a-website-before-its-first-test.md): Create a website without testing it, configure it, then start its first test when it is ready.
- [Tag websites](https://developers.silktide.com/guides/tag-websites.md): Make a tag, put it on websites with Update a website, and take it off again.
- [Connect Claude, ChatGPT or Cursor](https://developers.silktide.com/guides/connect-an-ai-client.md): Connect your own AI client to Silktide through its hosted MCP server, and what a connected client can and cannot do.
- [Build with a coding agent](https://developers.silktide.com/guides/build-with-a-coding-agent.md): A snippet for your project's AGENTS.md or CLAUDE.md that points Cursor, Claude Code, Codex and other coding agents at these docs.
- [Send events with the Silktide Script](https://developers.silktide.com/guides/send-events-with-the-silktide-script.md): Install the Silktide Script, send your own events with properties, record site search, and read it all back through the API.

## Concepts

- [Errors](https://developers.silktide.com/v1/concepts/errors.md): Every error has the same body. Detect it by its type, never by its message.
- [Rate limits](https://developers.silktide.com/v1/concepts/rate-limits.md): 75 requests to each path every five seconds, per key. Wait for Retry-After when you hit it.
- [Results](https://developers.silktide.com/v1/concepts/results.md): How the operations under /v1/results/ answer, which website they are about, and which dates.
- [Scores](https://developers.silktide.com/v1/concepts/scores.md): Silktide 4 and Silktide 5 score websites differently. Which scores operations to call, and how their ids match.
- [Websites and sections](https://developers.silktide.com/v1/concepts/websites-and-sections.md): A section is part of a website that Silktide reports on as if it were a website. Section 0 is the whole website.
- [Content](https://developers.silktide.com/v1/concepts/content.md): Pages are web pages, documents are PDFs, and content means both.
- [Tables](https://developers.silktide.com/v1/concepts/tables.md): Results that answer with rows take columns, sort and search, and answer one page of rows at a time.
- [Pagination](https://developers.silktide.com/v1/concepts/pagination.md): Results with many rows answer one page at a time. Ask for the next page until you reach maxPage.
- [Context](https://developers.silktide.com/v1/concepts/context.md): What a report is about. One website, or every website that matches some tags or a list.
- [Schedules](https://developers.silktide.com/v1/concepts/schedules.md): How often something repeats, such as a website's retests or a scheduled report, as an interval and a period.
- [Dates and times](https://developers.silktide.com/v1/concepts/dates-and-times.md): Times are Unix timestamps in seconds. Days in results are read in a time zone you choose.
- [Versions](https://developers.silktide.com/v1/concepts/versions.md): Every path starts with /v1. Documented v1 operations only gain things, and anything removed gets six months' notice.

## Platform

- [Platform overview](https://developers.silktide.com/v1/platform.md)
- [Balances](https://developers.silktide.com/v1/platform/balances.md)
- [Get what the account can still add](https://developers.silktide.com/v1/platform/balances/get-account-balance.md): Returns what the account can still add under its plan: websites, pages, documents and the other allowances.
- [Get what a website can be given](https://developers.silktide.com/v1/platform/balances/get-website-balance.md): Returns what one existing website can be given: the most pages and documents you can set when you update it, and the account's other allowances.
- [Roles](https://developers.silktide.com/v1/platform/roles.md)
- [List the account's roles](https://developers.silktide.com/v1/platform/roles/list-roles.md): Returns the account's roles.
- [Create a role](https://developers.silktide.com/v1/platform/roles/create-role.md): Creates a role, with no permissions and no members.
- [Assignees](https://developers.silktide.com/v1/platform/assignees.md)
- [List the account's roles and users as assignees](https://developers.silktide.com/v1/platform/assignees/list-assignees.md): Returns everyone and every role in the account that can be given something, such as a report to receive or a check to fix, keyed by assignee id.
- [Tags](https://developers.silktide.com/v1/platform/tags.md)
- [List the account's tags](https://developers.silktide.com/v1/platform/tags/list-tags.md): Returns every tag in the account, sorted by label, with how many things each one is on.
- [Create one or more tags](https://developers.silktide.com/v1/platform/tags/create-tag.md): Creates tags.
- [Update a tag](https://developers.silktide.com/v1/platform/tags/update-tag.md): Changes a tag's label, color or group.
- [Delete a tag and remove it everywhere](https://developers.silktide.com/v1/platform/tags/delete-tag.md): Deletes a tag at once and takes it off everything it was on.
- [Results](https://developers.silktide.com/v1/platform/results.md)
- [Get several results in one request](https://developers.silktide.com/v1/platform/results/get-several-results.md): Runs several results queries in one request, such as a website's scores, the trend of one score, its checks and one check in detail.

## Governance

- [Governance overview](https://developers.silktide.com/v1/governance.md)
- [Websites](https://developers.silktide.com/v1/governance/websites.md)
- [List websites and their sections](https://developers.silktide.com/v1/governance/websites/list-websites.md): Returns every website the API key's user can see, one entry per section.
- [Get a website's settings](https://developers.silktide.com/v1/governance/websites/get-website.md): Returns one website: its details, who may do what with it, when it is retested, and its settings.
- [Create a website](https://developers.silktide.com/v1/governance/websites/create-website.md): Creates a website and, unless you say otherwise, starts testing it straight away.
- [Update a website](https://developers.silktide.com/v1/governance/websites/update-website.md): Changes a website.
- [Test a website now](https://developers.silktide.com/v1/governance/websites/test-website.md): Starts a test.
- [Delete a website and everything in it](https://developers.silktide.com/v1/governance/websites/delete-website.md): Deletes a website at once, with its sections, results and history.
- [Get headline statistics for every website](https://developers.silktide.com/v1/governance/websites/get-website-stats.md): Returns the headline statistics of every live website in one call: scores, issue counts, page counts and the technology Silktide found.
- [Scores](https://developers.silktide.com/v1/governance/scores.md)
- [Get a website's Silktide 4 scores](https://developers.silktide.com/v1/governance/scores/get-scores.md): Returns every Silktide 4 score of a website or one of its sections, each as its latest value in the period.
- [Get how a Silktide 4 score changed over time](https://developers.silktide.com/v1/governance/scores/get-score-trend.md): Returns every measurement of one Silktide 4 score in the period, oldest first, for a website or one of its sections.
- [Get a website's Silktide 5 scores](https://developers.silktide.com/v1/governance/scores/get-module-scores.md): Returns a website's scores as Silktide 5 works them out: one for each module, and its WCAG conformance at each version and level.
- [Get how a Silktide 5 score changed over time](https://developers.silktide.com/v1/governance/scores/get-module-score-trend.md): Returns every measurement of one Silktide 5 score in the period, oldest first, for a website or one of its sections.
- [Checks](https://developers.silktide.com/v1/governance/checks.md)
- [List a website's checks and how each is doing](https://developers.silktide.com/v1/governance/checks/get-checks.md): Returns 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.
- [Get one check and its history](https://developers.silktide.com/v1/governance/checks/get-check.md): Returns 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.
- [List the pages and documents one check found issues on](https://developers.silktide.com/v1/governance/checks/get-check-contents.md): Lists 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](https://developers.silktide.com/v1/governance/content.md)
- [List the pages and documents Silktide tested](https://developers.silktide.com/v1/governance/content/get-contents.md): Lists every page and document Silktide tested on a website or one of its sections, a page of rows at a time.
- [Metadata](https://developers.silktide.com/v1/governance/metadata.md)
- [Get a section's metadata, and the properties it can have](https://developers.silktide.com/v1/governance/metadata/get-section-metadata.md): Returns a section's metadata values, and every metadata property the account defines, so you can show the empty ones too.
- [Set some of a section's metadata](https://developers.silktide.com/v1/governance/metadata/set-section-metadata.md): Sets some of a section's metadata values and returns all of them, as Get a section's metadata does.
- [Reports](https://developers.silktide.com/v1/governance/reports.md)
- [List reports](https://developers.silktide.com/v1/governance/reports/list-reports.md): Returns every report the API key's user can see, with no paging.
- [Get a report](https://developers.silktide.com/v1/governance/reports/get-report.md): Returns one report, as List reports lists it.
- [Get what a report shows](https://developers.silktide.com/v1/governance/reports/get-report-results.md): Returns what a report shows: the template it is built from, the template's widgets, and each widget's results under its widgetId.
- [Create a live report or a snapshot](https://developers.silktide.com/v1/governance/reports/create-report.md): Creates a report from a report template, and builds it.
- [Rename a report, or change what a live report covers](https://developers.silktide.com/v1/governance/reports/update-report.md): Changes a report.
- [Delete a report](https://developers.silktide.com/v1/governance/reports/delete-report.md): Deletes a report and its results at once.
- [Report schedules](https://developers.silktide.com/v1/governance/report-schedules.md)
- [List report schedules](https://developers.silktide.com/v1/governance/report-schedules/list-report-schedules.md): Returns every report schedule the API key's user can see, with no paging.
- [Get a report schedule and who it emails](https://developers.silktide.com/v1/governance/report-schedules/get-report-schedule.md): Returns one report schedule and who it emails.
- [Create a report schedule](https://developers.silktide.com/v1/governance/report-schedules/create-report-schedule.md): Creates a report schedule: on each run it makes a snapshot from a report template and emails it to its subscribers.
- [Update a report schedule or who it emails](https://developers.silktide.com/v1/governance/report-schedules/update-report-schedule.md): Changes a report schedule, who it emails, or both.
- [Delete a report schedule](https://developers.silktide.com/v1/governance/report-schedules/delete-report-schedule.md): Deletes a report schedule at once, so it makes no more snapshots and sends no more emails.
- [Report templates](https://developers.silktide.com/v1/governance/report-templates.md)
- [List report templates](https://developers.silktide.com/v1/governance/report-templates/list-report-templates.md): Returns every report template the API key's user can see, sorted by name, with no paging.
- [User flows](https://developers.silktide.com/v1/governance/user-flows.md)
- [List a website's user flows, how reliably each runs, and the pages it reached](https://developers.silktide.com/v1/governance/user-flows/get-flows.md): Lists a website's user flows: each one's last run, how often its runs succeeded over 30 and 90 days, and the page each of its steps reached.
- [Testing](https://developers.silktide.com/v1/governance/testing.md)
- [Test a piece of HTML for spelling, grammar and accessibility issues](https://developers.silktide.com/v1/governance/testing/test-html-fragment.md): Tests a piece of HTML, such as <h1>Our wines</h1> or a whole draft page, there and then, and answers with what each check found.

## Analytics

- [Analytics overview](https://developers.silktide.com/v1/analytics.md)
- [Audience](https://developers.silktide.com/v1/analytics/audience.md)
- [Get how many people visited, step by step over a period](https://developers.silktide.com/v1/analytics/audience/get-visitors-over-time.md): Returns how many people visited in each step of a period, and across the whole of it, for an analytics view or a website.
- [Get how many pages were viewed, step by step over a period](https://developers.silktide.com/v1/analytics/audience/get-page-views-over-time.md): Returns how many pages were viewed in each step of a period, and across the whole of it, for an analytics view or a website.
- [Get the share of visits that bounced, step by step over a period](https://developers.silktide.com/v1/analytics/audience/get-bounce-rate-over-time.md): Returns the share of visits that bounced in each step of a period, and across the whole of it, for an analytics view or a website.
- [Get how long visits lasted, step by step over a period](https://developers.silktide.com/v1/analytics/audience/get-duration-over-time.md): Returns how long the average visit lasted in each step of a period, and across the whole of it, for an analytics view or a website.
- [List the countries visitors came from](https://developers.silktide.com/v1/analytics/audience/get-countries.md): Lists the countries visits came from, with each country's visitors and page views, most visitors first.
- [List the regions within countries that visitors came from](https://developers.silktide.com/v1/analytics/audience/get-regions.md): Lists the regions within countries that visits came from, such as states, provinces or the nations of the United Kingdom, with each region's visitors and page views, most visitors first.
- [List the browsers visitors used](https://developers.silktide.com/v1/analytics/audience/get-browsers.md): Lists the browsers visitors used, with each one's visitors and page views, most visitors first.
- [List the operating systems visitors used](https://developers.silktide.com/v1/analytics/audience/get-operating-systems.md): Lists the operating systems visitors used, with each one's visitors and page views, most visitors first.
- [List the sizes of browser window visitors used](https://developers.silktide.com/v1/analytics/audience/get-browser-sizes.md): Lists how wide visitors' browser windows were, grouped into sizes, with the visitors and page views at each, smallest first.
- [Get visitors at each browser size, step by step over a period](https://developers.silktide.com/v1/analytics/audience/get-browser-sizes-over-time.md): Returns one series per browser size, with the visitors at that size in each step of a period, for an analytics view or a website.
- [Acquisition](https://developers.silktide.com/v1/analytics/acquisition.md)
- [List where visitors came from, one row per source and medium](https://developers.silktide.com/v1/analytics/acquisition/get-sources.md): Lists where visitors came from: a search engine, a social network, an AI assistant such as ChatGPT, an email, or another website that linked to yours.
- [Get visitors from the busiest sources, step by step](https://developers.silktide.com/v1/analytics/acquisition/get-sources-over-time.md): Draws the busiest sources as lines over time: unique visitors from each, step by step through the period.
- [List the campaigns visitors arrived through](https://developers.silktide.com/v1/analytics/acquisition/get-campaigns.md): Lists the campaigns visitors arrived through.
- [Get visitors from the busiest campaigns, step by step](https://developers.silktide.com/v1/analytics/acquisition/get-campaigns-over-time.md): Draws the busiest campaigns as lines over time: unique visitors who arrived through each, step by step through the period.
- [Content](https://developers.silktide.com/v1/analytics/content.md)
- [List the pages people viewed](https://developers.silktide.com/v1/analytics/content/get-pages.md): Lists the pages people viewed, with how often and for how long.
- [List the landing pages visits began on](https://developers.silktide.com/v1/analytics/content/get-entry-pages.md): Lists landing pages: the first tracked page of each visit, and how many visits began on each.
- [List the pages visits ended on](https://developers.silktide.com/v1/analytics/content/get-exit-pages.md): Lists exit pages: the last tracked page of each visit, and how many visits ended on each.
- [List the files people downloaded](https://developers.silktide.com/v1/analytics/content/get-downloads.md): Lists the files people downloaded from your website, such as PDFs, documents and spreadsheets.
- [List the links people left your website through](https://developers.silktide.com/v1/analytics/content/get-outgoing-links.md): Lists the outgoing links people clicked: links on your pages that lead to another website.
- [List the pages where people met dead clicks](https://developers.silktide.com/v1/analytics/content/get-frustration-pages.md): Lists the pages where people got stuck.
- [Engagement](https://developers.silktide.com/v1/analytics/engagement.md)
- [List the events visitors sent, with how often and by how many](https://developers.silktide.com/v1/analytics/engagement/get-events.md): Lists every event sent in the period, one row each, most sent first: the events your site sends with silktide("…"), and the ones the Silktide Script records by itself (pageload, click, download, frustration and the others).
- [Get how often each event was sent, step by step](https://developers.silktide.com/v1/analytics/engagement/get-events-over-time.md): Counts how often events were sent across the period, one line per event in multiSeries, and every event together in total and series.
- [List the properties an event was sent with](https://developers.silktide.com/v1/analytics/engagement/get-event-properties.md): Lists the properties one event was sent with, most sent first.
- [Rank the values one property of an event was sent with](https://developers.silktide.com/v1/analytics/engagement/get-event-property-values.md): Ranks one property's values, most sent first, with the number of times each was sent.
- [List every time an event was sent, newest first](https://developers.silktide.com/v1/analytics/engagement/get-event-occurrences.md): Lists every time one event was sent, newest first.
- [List goals and how often each was completed](https://developers.silktide.com/v1/analytics/engagement/get-goals.md): Lists every goal of the view, or of the website, with how many times each was completed in the period and the share of visitors who completed it, most completed first.
- [List what people searched your site for](https://developers.silktide.com/v1/analytics/engagement/get-site-search-terms.md): Lists every term people typed into your site's own search boxes in the period, with its searches and visitors, most searched first.
- [Count searches of your site, step by step](https://developers.silktide.com/v1/analytics/engagement/get-site-searches-over-time.md): Counts searches of your site's own search boxes over the period, one entry per step.

## Resources

- [Changelog](https://developers.silktide.com/v1/changelog.md): Every change to the Silktide API, newest first.

## Optional

- [OpenAPI 3.1](https://developers.silktide.com/v1/openapi.json)
- [Everything in one file](https://developers.silktide.com/llms-full.txt)