Get report list API in Assisted Tests
Use this API to get a list of reports along with the basic details of these reports.
get report list
For geo-restricted data, use the following endpoints:
https://accessibility-eu.browserstack.com/api/assisted-test/v1/reports (European Union)
https://accessibility-in.browserstack.com/api/assisted-test/v1/reports (India)
Request parameters
Request
curl -u "YOUR_USERNAME:YOUR_ACCESS_KEY" \
https://api-accessibility.browserstack.com/api/assisted-test/v1/reports
-
next_page String
Used to fetch subsequent pages from the API when has_next parameter is true. Pass the next_page reference received in the response of last request.
Response Attributes 200 OK JSON
Response
{
"reports": [
{
"id": 30648,
"name": "Google Workflow",
"createdBy": {
"user_id": 6456742,
"name": "John Doe"
},
"status": "completed",
"needsReview": true,
"bestPractices": false,
"advanced": true,
"scanType": "Full page",
"engineInfo": {
"testEngine": {
"name": "a11y_engine",
"version": "3.3.0"
}
},
"assistedTestType" : "keyboard",
"issueSummary": {
"componentCount": 11,
"issueCount": 14,
"pageCount": 2
}
},
{
"id": 7180,
...
},
.
.
],
"pagination": {
"has_next": true,
"next_page": "eyJhbGciOiJIUzI1NiJ9.eyJwYWdlIjoxLCJwYWdlX3NpemUiOjEwLCJidWlsZF91dWlkIjoic3pkdGplMnhsaHNydWZkajF3bnJnYnZndnNmZzJjdGRsdWt4Nnl5eCIsImV4cCI6MTczNjY4NDA1OH0.sLI7hWQwE_bB6AB-ORgz1K6D2VIHqH_H39qK8Jh3HqA"
}
}
-
id Integer
Unique ID of the report.
-
name String
Name of the report.
-
createdBy Object
â–¶ SHOW VALUESSpecifies the id and name of the creator of the report.
-
id Integer
ID of the report creator.
-
name String
Name of the report creator.
-
-
status String
The status of the report. “Finalizing” means that advanced rules are being evaluated and issues are still being processed. “Completed” means the complete report has been generated.
-
needsReview Boolean
True if issues that require manual confirmation are included.
- Show 7 more
-
bestPractices Boolean
True if best practices rules are included. These are not WCAG violations but are good to have to ensure accessibility.
-
advanced Boolean
True if reporting of issues in violation of advanced rules is enabled.
-
scanType String
Indicates whether the scope of the scan was the entire page or part of the page.
-
engineInfo Object
â–¶ SHOW VALUESContains test engine info.
-
testEngine Object
â–¶ SHOW VALUESName and version of the rule engine used.
-
name String
Name of the rules engine.
-
version String
Version of the rules engine.
-
-
-
assistedTestType String
Type of assisted test.
-
issueSummary Object
â–¶ SHOW VALUESContains a summary of the accessibility issues found out in the scan.
-
componentCount Integer
Number of components that have accessibility issues.
-
issueCount Integer
Number of issues reported.
-
pageCount Integer
Number of pages that have accessibility issues.
-
-
pagination Object
â–¶ SHOW VALUESContains information to facilitate fetching additional records if they exist.
-
has_next Boolean
True if there are more records to fetch. False if the current response is the last page of records.
-
next_page String
A reference to the next page. Pass this as a request parameter in the subsequent request as “next_page” to get the next page of records.
-
We're sorry to hear that. Please share your feedback so we can do better
Contact our Support team for immediate help while we work on improving our docs.