API & IntegrationsDocumentation

API: Runs

Poll the status of async scan and collection operations.

Run Status

Polling strategy

Poll every 5–10 seconds. Use exponential backoff for large scans with 500+ pages to avoid hitting rate limits.

GET/v1/runs/:runIdAuthenticated

Retrieve the current status of an async run. Use this to poll after starting a scan or page collection. The run is scoped to your organisation — you cannot access runs from other accounts.

curl -H "x-api-key: $ABLELYTICS_API_KEY" \
  https://api.ablelytics.com/v1/runs/RUN_ID

Response

{
  "data": {
    "id": "clxr7890",
    "type": "scan_pages",
    "status": "running",
    "pagesTotal": 120,
    "pagesScanned": 64,
    "stats": {
      "critical": 2,
      "serious": 8,
      "moderate": 14,
      "minor": 31
    },
    "startedAt": "2024-01-15T10:00:00Z",
    "finishedAt": null,
    "createdAt": "2024-01-15T09:58:00Z",
    "project": {
      "id": "clxk1234",
      "name": "Marketing Site",
      "domain": "https://example.com"
    }
  }
}

Status Codes

200 OK401 Unauthorized404 Not Found500 Internal Server Error

→status transitions: queued → running → done | failed | cancelled
→stats is populated progressively as pages are scanned.
→Poll every 5–10 seconds. Stop when status is done or failed.

API: Reports

Generate, poll, download, and delete accessibility reports.

API: Pagination

Cursor-based pagination for list endpoints.