Appearance
API Keys
To use the API, you must first create an API key on the API keys tab of Settings (Premium plan and above).
Click Generate key, give the key a name and choose when it expires (Never expires, 6 months or 1 year), then click Generate key in the dialog. The key is shown only once — copy it with Copy key and store it somewhere safe. An organization can have up to 10 keys; delete a key from the list to revoke it.
API tokens are organization-specific and allow access only to data and operations for that organization.
Available API Endpoints:
- Get list of projects – Returns all projects (sites) in the specified organization.
- Get list of tags – Retrieves all tags for a specific project, including their match rules.
- Get dashboard for project – Provides accessibility score, issue counts, and related metrics for a given time period.
- Get reports – Returns aggregated accessibility issue data for the selected period.
- Get accessibility score – Retrieves the overall accessibility score for a project within the selected timeframe.
- Get reports for specific error – Lists pages where a given error type occurs, along with counts and device info.
- Error definitions – Returns descriptions for all error codes used in reports.