Get headline statistics for every website

GET/v1/websites/stats

Returns the headline statistics of every live website in one call: scores, issue counts, page counts and the technology Silktide found. Websites still in setup are left out.

websites and each sections are objects keyed by id, not arrays, and stay objects ({}) when empty. Section 0, the whole website, is not in sections: its statistics are the website's own stats.

Websites do not all have the same statistics, so read them by id and expect some to be missing. A statistic with no value yet is null.

This call returns everything at once, which is slow for an account with many websites. To read one website, or a statistic over time, use the results queries instead.

Request

curl "https://api.eu.silktide.com/v1/websites/stats" \
  -H "Authorization: silktide token=$SILKTIDE_API_KEY"

Response: One website with one section

{
  "websites": {
    "2": {
      "name": "Example",
      "homeUrl": "https://example.com/",
      "websiteId": 2,
      "stats": {
        "overall.score": {
          "label": "Overall score",
          "value": 73.6
        },
        "wcag-22-aa.score": {
          "label": "WCAG 2.2 AA score",
          "value": 88.2
        },
        "website.pages": {
          "label": "Pages tested",
          "value": 812
        },
        "technology.cms": {
          "label": "Most used CMS",
          "value": "WordPress"
        }
      },
      "sections": {
        "3": {
          "name": "Blog",
          "homeUrl": "https://example.com/blog/",
          "sectionId": 3,
          "stats": {
            "overall.score": {
              "label": "Overall score",
              "value": 70.1
            }
          }
        }
      }
    }
  }
}

Request

No parameters.

Response

200JSON.

websitesmap of objectsrequired
Each live website the API key's user can see, by website id.
Show 5 fieldsHide fields
- namestringrequired
  The website's name.
- homeUrlstringrequired
  Its home page.
- websiteIdintegerrequiredat least 1
  The website.
- statsmap of objectsrequired
  Headline statistics by id, such as overall.score or website.pages.
  Show 2 fieldsHide fields
  - labelstringrequired
    The statistic's name, in the API user's language.
  - valuenumber or stringrequiredcan be null
    Its value. Usually a number; a name for technology statistics; null when there is none yet.
- sectionsmap of objectsrequired
  Its sections other than section 0, by section id. {} when it has none.
  Show 4 fieldsHide fields
  - namestringrequired
    The section's name.
  - homeUrlstringrequired
    Its home page. Can be empty.
  - sectionIdintegerrequired
    The section.
  - statsmap of objectsrequired
    Headline statistics by id, such as overall.score or website.pages.
    Show 2 fieldsHide fields
    labelstringrequired
    The statistic's name, in the API user's language.
    valuenumber or stringrequiredcan be null
    Its value. Usually a number; a name for technology statistics; null when there is none yet.

Errors

Status	Type	When
401	`NotLoggedIn`	No API key was sent, or it is not a key for this region.(any operation)
429	`TooManyRequests`	Too many requests to this path in five seconds. Retry after the number of seconds in the `Retry-After` header, which `properties.retryAfter` repeats.(any operation)
503	-	Silktide is busy. Retry after the number of seconds in the `Retry-After` header.(any operation)

Every error has the same body. See Errors.

Access

Permission: Any user of the account
Plan feature: None
Edition: Silktide 4 and Silktide 5
Cost: Free
Available since: v1.0.0

Try it

Sends a real request to your account from this browser. Your key stays in this tab and goes only to the Silktide API.

Request

curl "https://api.eu.silktide.com/v1/websites/stats" \
  -H "Authorization: silktide token=$SILKTIDE_API_KEY"

Response: One website with one section

{
  "websites": {
    "2": {
      "name": "Example",
      "homeUrl": "https://example.com/",
      "websiteId": 2,
      "stats": {
        "overall.score": {
          "label": "Overall score",
          "value": 73.6
        },
        "wcag-22-aa.score": {
          "label": "WCAG 2.2 AA score",
          "value": 88.2
        },
        "website.pages": {
          "label": "Pages tested",
          "value": 812
        },
        "technology.cms": {
          "label": "Most used CMS",
          "value": "WordPress"
        }
      },
      "sections": {
        "3": {
          "name": "Blog",
          "homeUrl": "https://example.com/blog/",
          "sectionId": 3,
          "stats": {
            "overall.score": {
              "label": "Overall score",
              "value": 70.1
            }
          }
        }
      }
    }
  }
}

Try it

Sends a real request to your account from this browser. Your key stays in this tab and goes only to the Silktide API.