Upload Results to the Mobile Dashboard

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

Send Results to the Dashboard

Use scan results to discover accessibility failures and send them to the axe DevTools Mobile Dashboard.

try axe?.postResult(result)   

About the Dashboard

The axe DevTools Mobile Dashboard is a central location where your whole team can view and manage accessibility issues found in your app.

From the dashboard you are able to:

  • Find results for accessibility scans
  • Group scans
  • Share a scan/group of scans
  • Filter scans
  • Decide which results matter most and adapt your tests

Visit the docs for axe DevTools Mobile Dashboard to learn more.

Create a Scan Group URL from axeDevToolsResultKey

When you upload your scan to the Mobile Dashboard, the scan result returned from the POST request has the axeDevToolsResultKey object. This object has four properties: packageName, userId, resultId, and uuid. Using the uuid property, you can create a URL directing to a group of up to 20 results on the Dashboard. Use the following as a guide for the scan URL structure:

\(dashboardBaseURL)/scans?uuids=\(uuidsSeperatedWithComma)

Example

var uuids: [String] = []

// Navigate to screen 1 and perform a scan
let scan1 = try axe.run(onBundleIdentifier: bundleId)
// Upload scan results to dashboard
let resultKey1 = try axe.postResult(scan1)
// Add UUID to array of UUIDs
uuids.append(resultKey1.uuid)

// Navigate to screen 2 and perform a scan
let scan2 = try axe.run(onBundleIdentifier: bundleId)
// Upload scan results to dashboard
let resultKey2 = try axe.postResult(scan2)
// Add UUID to array of UUIDs
uuids.append(resultKey2.uuid)

// Add more scans - UUID list limit is 20

// Join the UUIDs into a single comma separated String
let uuidsString = uuids.joined(separator: ",")

// Construct group scan URL
var components = URLComponents(string: "https://axe-mobile.deque.com")!
components.path = "/scans"
components.queryItems = [URLQueryItem(name: "uuids", value: uuidsString)]
let url = components.url!

// Output the URL in the Xcode console. (UUIDs should be full length)
print(url) // https://axe-mobile.deque.com/scans?uuids=xxx-xxx-xxx,yyy-yyy-yyy