Transition to Axe Developer Hub APIs for Mobile Results

This page is not available in the language you requested. You have been redirected to the English version of the page.
Link to this page copied to clipboard
Not for use with personal data

If you have been calling the mobile-service REST API from your own scripts, you should know that the mobile-service is being retired. Results now live in Axe Developer Hub. Refer to maintained API documentation on the following pages:

This page is designed to help API users understand this transition. You can disregard this page if you are using our SDKs, Appium drivers, or Mobile Analyzers.

Using the Axe Developer Hub APIs

With each of the Developer Hub APIs, you will pass your Axe DevTools Mobile API Key into the headers for authentication.

Key Value
X-API-Key YOUR_API_KEY

Use the Projects endpoint to return a list of your mobile projects and access the unique Project ID for each one. You will need a Project ID to call the Sessions endpoint. Call the Sessions endpoint using the project ID to retrieve all the sessions for a given project. Each session ID from this response can be passed to the Results endpoint.

Output Format

Results are returned as Axe Universal JSON, a standard format used by all Axe products. It contains the accessibility testing results, but does not include a screenshot or the mobile view hierarchy. Mobile JSON includes all of the information captured at the time of the scan, including the accessibility testing results, the entire mobile view hierarchy, and a screenshot. Though Mobile JSON is not available through the API, you can export your data in this format from the Axe Developer Hub UI.

Migrating from the mobile-service REST API

Since results from the Axe Developer Hub APIs come from sessions rather than single scans, functionality will be different than with the mobile-service.

  • Use the Sessions and Results API for full scan summaries as well as filtered scan summaries
  • With the mobile-service API, you could POST scan results to the Mobile Dashboard. Now you will need to use our SDKs or Appium drivers and invoke startScanSession to send results to Axe Developer Hub
  • You are not able to update individual scan names programmatically, although you can rename the session in the Axe Developer Hub UI
  • Note that with the Axe Developer Hub APIs you will no longer be able to update a scan's tag(s) or delete individual scans
note

Old scans will stay in the mobile-service and can still be read through the old API through December 31, 2026.

Is this page helpful?

Help us improve this page

Still need help?