Retrieve a list of high-level statistics for all websites in an account.
This API is convenient for requesting all of your data in one go. It is not well suited to organizations with lots of websites. See individual Results for alternatives.
GET /v1/websites/stats
Simplified response, showing a subset of the full stats supported:
{
"websites": {
"2": {
"name": "Demo Website",
"homeUrl": "https:\\/\\/fakewinebarrel.com\\/",
"websiteId": 2,
"stats": {
"audit.score": {
"label": "Audit score",
"value": 64.565216
},
"consent.score": {
"label": "Consent score",
"value": 58.599998
},
"content-seo.score": {
"label": "Content SEO score",
"value": 26.88991
},
},
"sections": {
"3": {
"name": "Wines selection",
"homeUrl": "<https://www.example.com/wines>",
"sectionId": 3,
"stats": {
"wcag-20-a.score": {
"label": "WCAG 2.0 A score",
"value": 60.510262
},
"wcag-20-aa.score": {
"label": "WCAG 2.0 AA score",
"value": 54.042248
},
"wcag-20-aaa.score": {
"label": "WCAG 2.0 AAA score",
"value": 52.114101
},
"wcag-20.score": {
"label": "Accessibility (WCAG 2.0) score",
"value": 63.363632
}
}
}
}
}
}
}
Each result inside the key of websites will be keyed by the Website ID and contains key information about the website.
This includes the stats
object which will return the headline stats for that website at the current moment in time.
The sections
object inside a website
is keyed by the Section ID, and will contain key information about the section and another stats
object for just that section.
Each statistic contains a brief description as to what this is used for.