Ablelytics Client Documentation
Everything you need to run scans, interpret accessibility results, and deliver compliance-ready reports. Start with the docs below or pick a path.
Quick start
- 1. Create a project
- 2. Crawl or upload a sitemap
- 3. Run a scan and review issues
- 4. Generate a report
Choose your path
Tailored entry pointsFind documentation
Search by feature, workflow, or topic.
Getting Started
Getting Started
Create your first project, discover pages, and run a scan in minutes.
Getting Started
Onboarding & Workspace
Set up your account, roles, and organization context.
Core Concepts
Projects & Domains
How projects are structured and how domains are used during scanning.
Scanning & Crawling
Page Collection (Crawling)
Use the crawler to discover pages and build your coverage map.
Scanning & Crawling
Scans & Runs
Understand runs, statuses, and how scans are processed.
Scanning & Crawling
Interpreting Results
How to read issues, severity, and WCAG references.
Reporting
Reports
Generate professional PDF reports for stakeholders and audits.
Administration
Billing & Usage
Manage plans, trials, and usage limits.
API & Integrations
Integrations & API
REST API overview, authentication, rate limits, and links to endpoint references.
API & Integrations
API: Auth and Health
Authentication, rate limit headers, and the public health check endpoint.
API & Integrations
API: Projects
List, create, update, configure settings, and delete projects.
API & Integrations
API: Pages and Collection
Manage pages and trigger async page collection (crawl).
API & Integrations
API: Page Sets
Create and manage page sets for focused scans and reports.
API & Integrations
API: Scans and Issues
Trigger async accessibility scans and retrieve per-page issue results.
API & Integrations
API: Reports
Generate, poll, download, and delete accessibility reports.
API & Integrations
API: Runs
Poll the status of async scan and collection operations.
API & Integrations
API: Pagination
Cursor-based pagination for list endpoints.
API & Integrations
API: Error Reference
Standard error format and HTTP status code reference.
API & Integrations
API: CI/CD Integration
Integrate accessibility scanning into GitHub Actions and other CI/CD pipelines.
Support
Troubleshooting
Common issues and how to resolve them quickly.