API reference
Endpoints
| Method | Path | Description |
|---|---|---|
| GET | /api/v1/sites | List sites |
| GET | /api/v1/checks | List checks |
| POST | /api/v1/runs | Start a run |
| GET | /api/v1/runs?limit=&before= | List runs |
| GET | /api/v1/runs/{id} | Read a run |
| POST | /api/v1/runs/{id}/cancel | Cancel a run |
Start a run with urls, site_ids, or checks. Every call carries Authorization: Bearer <key>.
Run states
queuedrunningdonefailedcancelled
Errors
| HTTP code | Description |
|---|---|
| 400 | a bad body, URL, site or check id: the answer says which |
| 401 | API key required: Authorization: Bearer <key> or unknown API key |
| 403 | the API needs the Team plan or higher |
| 404 | no such run |
| 409 | run is already done or run is already cancelled |
| 429 | 50 runs are already waiting; let them run or cancel some first |
Errors are returned in error.
Check results
| Passed | pass |
|---|---|
| Failed | fail |
| Sites with a failure | failing_sites |
| Needs a look | look |
| Not run | not_checked |
| Not on this site | absent |
Needs a look means the check stopped before it could tell. It is not a failure and does not change the exit code. The run's summary counts each result.
A few practical details
- Test accountSet email and password on the site's page. Used only by checks that sign in or write.
- Where it runsEverything runs on qa.pro. Nothing to install. Private or VPN-only addresses cannot be checked.
- Your dataTeam admins can export sites, checks and verdicts in Settings. Screenshots stay on report pages. A data processing agreement is available on request.