Usage Service
Learn about your teams' usage and metrics through the axe DevTools Usage Service.
How to enable the Usage Service | About the Usage Service
Now in axe-devtools-android version 5.4.0+
Usage data is now captured automatically when your team has enabled Usage Service tracking through the axe Account Portal.
NOTE: The previous implementation has been deprecated, it will be fully removed from the library in a future release.
Previous Versions
Disabled by default, you must opt-in by defining your Deque provided Organization ID
during setup to start collecting usage data.
Opt In
On your initialized AxeDevTools
object, set the organization ID prior to authenticating and running any scans.
axe.setOrgIdForUsageService("<ORG_ID>")
Full Example in Espresso
@test
fun runScanWithADTAndroid() {
axe.setOrgIdForUsageService("<ORG_ID>")
axe.loginWithApiKey("<DEQUE_API_KEY>")
rule.scenario.onActivity {
val scan = axe.scan(it)
Assert.assertNull(scan)
axe.tearDown()
}
}
Captured Data
When interacting with the Usage Service through axe DevTools Mobile, you can expect the below data sent for login or scanning events:
Key | Description |
---|---|
productName | axe-devtools-mobile |
event | Which event took place: login or scan . |
organization | Your Deque provided Organization ID . |
productComponent | android-sdk |
productComponentVersion | Version number of the axe DevTools Mobile library. |
distinctId | Universally Unique Identifier (UUID) |
userId | Email address of the person initiating the event. |
dateTime | Time stamp of the event. |