Analyze Inventory of Monitored Mobile Apps with REST API (Version 1.0)

Use MOBILE_APPLICATIONS_INVENTORY to track the versions of all monitored mobile apps on devices which reported during the past seven days.

For example, if you issued several upgrades to your mobile apps, you can track the versions deployed on each device, to ensure users are running the proper version.

Each entry from MOBILE_APPLICATIONS_INVENTORY returns a monitored mobile app's name, version, ID and Aternity Mobile version, along with details of the mobile device and the username. If you use $select to display only specific columns, it makes the query faster by grouping all rows with identical attribute values into a single row with aggregated measurements.

Before You Begin

To send a REST API query in Excel, PowerBI or a browser, enter the URL of the REST API, your Aternity username (must have the OData REST API role) and its password. You can find this by selecting User icon > REST API Access. SSO users must generate (once) and use a special password, as Aternity's REST API does not authenticate with your enterprise's identity provider.

To view an Aternity REST API, enter the base URL from User icon > REST API Access, followed by the name of the API: <base_url>/API_NAME into a browser, Excel or PowerBI (learn more). :

Tip

Wherever possible, use $select and $filter to narrow your query, to avoid receiving an error like Returned data is too large. Learn more.

Examples

To access this API from a browser, Excel or Power BI (learn more), enter <base_url>/MOBILE_APPLICATIONS_INVENTORY

To see if everyone is using the latest version of a specific app like WorxMail, view the app's version number and the version of its Aternity Mobile:

<base_url>/MOBILE_APPLICATIONS_INVENTORY?$filter=application eq 'WorxMail'&$select=application_version,sdk_version

To check all devices have the latest iOS, enter:

<base_url>/MOBILE_APPLICATIONS_INVENTORY?$filter=os_family eq 'iOS'&$select=os_version

To list the usernames which have a particular version of a specific app, enter:

<base_url>/MOBILE_APPLICATIONS_INVENTORY?$filter=application eq 'WorxMail' and application_version eq 'w1.0.1'&select=username

Supported Parameters

You can view the data by entering the URL into Excel, into a browser, or into or any OData compatible application such as Power BI.

You can add parameters to the URL to filter the returned data, by adding a question mark (?) followed by a parameter and value, such as .../API_NAME?$filter=(USERNAME eq 'jsmith@company.com'), or several parameter-value pairs each separated by an ampersand (&), like .../API_NAME?$format=xml&$top=5.

Parameter Description
$select=

Use $select to return only specific columns (attributes), to make queries more efficient: ...API_NAME?$select=COL1,COL2,COL3

$filter=

Use $filter to insert conditions that narrow down the data, to return only entries where those conditions are true..

Create conditions with operators: and, or, eq (equals) gt (greater than), ge (greater than or equal), lt (less than), le (less than or equal), ge (greater than or equal to), ne (not equal to), le (less than or equal to), not and contains. Use operators with parentheses to group conditions logically: .../API_NAME?$filter=(COLUMN1 eq 'value1' or COL2 neq 'val2') and (COL3 gt number) and not (COL4 eq 'val4' or contains(COL5,'val5'))

$format=

Use $format to force the returned data to be either in XML or JSON format. This is only useful for testing the raw data in a web browser. For example: .../API_NAME?$format=xml

$orderby=

Use $orderby to sort the returned data according to the value you choose. For example, .../API_NAME?$orderby=LOCATION

$top=

Use $top (lower case only) when you are initially testing the response of the API by returning the first few entries.

For example, to return the first five entries (not sorted), use: ...API_NAME?$top=5

$search is NOT supported.

Do not use $search in Aternity's REST APIs.

If you use $select to display only specific columns, it makes the query faster by grouping all rows with identical attribute values into a single row with aggregated measurements. For example, if you use $select to return only the RAM size and CPU usage, if 50 devices have the same attribute of 16GB RAM, it condenses them into a single row and outputs their CPU usage as a single weighted average measurement.

Tip

Wherever possible, use $select and $filter to narrow your query, to avoid receiving an error like Returned data is too large. Learn more.

Output

Each entry from MOBILE_APPLICATIONS_INVENTORY returns a monitored mobile app's name, version, ID and Aternity Mobile version, along with details of the mobile device and the username. If you use $select to display only specific columns, it makes the query faster by grouping all rows with identical attribute values into a single row with aggregated measurements.

You can access data using this API (retention) going back up to 7 days.

Types Returned columns

Measurements

N/A

Attributes

Account_ID,Account_Name,Application_ID,Application_Version,Device_Manufacturer,Device_Model,Device_Name,Device_Type,Mobile_Device_ID,OS_Family,OS_Name,OS_Version,SDK_Version,Username