API & IntegrationsDocumentation

API: Reports

Generate, poll, download, and delete accessibility reports.

Report Endpoints

GET/v1/projects/:id/reportsAuthenticated

List all reports for the project, newest first.

Query Parameters

Name	Type	Required	Description
limit	integer	optional	Reports to return. Default 50.
after	string	optional	Pagination cursor.

curl -H "x-api-key: $ABLELYTICS_API_KEY" \
  https://api.ablelytics.com/v1/projects/PROJECT_ID/reports

Response

{
  "data": [
    {
      "id": "reportId",
      "title": "Q1 Accessibility Audit",
      "status": "completed",
      "pdfUrl": "https://storage.googleapis.com/bucket/report.pdf",
      "createdAt": "2024-01-15T09:00:00Z"
    }
  ],
  "pagination": { "limit": 50, "nextCursor": null, "hasMore": false }
}

Status Codes

200 OK401 Unauthorized404 Not Found500 Internal Server Error

POST/v1/projects/:id/reportsAuthenticated

Queue a new PDF accessibility report for the project. Returns immediately with status generating. Poll the GET endpoint until status is completed and pdfUrl is available.

curl -X POST https://api.ablelytics.com/v1/projects/PROJECT_ID/reports \
  -H "x-api-key: $ABLELYTICS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"title":"Q1 Audit","type":"project"}'

Request Body

{
  "title": "Q1 Accessibility Audit",
  "type": "project"
}

Response

{
  "data": {
    "id": "reportId",
    "title": "Q1 Accessibility Audit",
    "status": "generating",
    "pdfUrl": null,
    "createdAt": "2024-01-15T09:00:00Z"
  }
}

Status Codes

201 Created400 Bad Request401 Unauthorized404 Not Found500 Internal Server Error

→Poll GET /v1/projects/:id/reports/:reportId until status is completed.
→pdfUrl is populated once generation finishes.

GET/v1/projects/:id/reports/:reportIdAuthenticated

Fetch a single report record. Poll this endpoint after creation to check for pdfUrl availability.

curl -H "x-api-key: $ABLELYTICS_API_KEY" \
  https://api.ablelytics.com/v1/projects/PROJECT_ID/reports/REPORT_ID

Response

{
  "data": {
    "id": "reportId",
    "title": "Q1 Accessibility Audit",
    "status": "completed",
    "pdfUrl": "https://storage.googleapis.com/bucket/report.pdf",
    "createdAt": "2024-01-15T09:00:00Z"
  }
}

Status Codes

200 OK401 Unauthorized404 Not Found500 Internal Server Error

DELETE/v1/projects/:id/reports/:reportIdAuthenticated

Delete a report record. The associated PDF file in cloud storage is also removed.

curl -X DELETE \
  https://api.ablelytics.com/v1/projects/PROJECT_ID/reports/REPORT_ID \
  -H "x-api-key: $ABLELYTICS_API_KEY"

Response

{
  "data": { "id": "reportId", "deleted": true }
}

Status Codes

200 OK401 Unauthorized404 Not Found500 Internal Server Error

API: Scans and Issues

Trigger async accessibility scans and retrieve per-page issue results.

API: Runs

Poll the status of async scan and collection operations.