Analyze Inventory of Monitored Mobile Apps with REST API (version 2.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.

Note

This article covers the latest REST API version. For older version 1.0, click here.

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 Aternity REST API, enter the base URL from Aternity > User icon > REST API Access, followed by the name of the API into a browser, Excel or PowerBI (learn more). For VIEWING, use <base_url>/latest/API_NAME; for INTEGRATIONS, use <base_url>/<version number>/API_NAME (for example, <base_url>/v1/API_NAME, or <base_url>/v1.0/API_NAME, or <base_url>/v2/API_NAME, or <base_url>/v2.0/API_NAME).

Get the latest REST API version for analyzing in the external app
:
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>/latest/MOBILE_APPLICATIONS_INVENTORY or <base_url>/v2/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:

.../MOBILE_APPLICATIONS_INVENTORY?$filter=application eq 'WorxMail'&$select=application_version,mobile_sdk_version

To check all devices have the latest iOS, enter:

.../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:

.../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.

Query Options Description
$select=

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

$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

$filter=

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

Create conditions for filtering with any of the following operators:

Query Operators Description
eq

Equal to

For example, COL4 eq 'val4'

ne

Not equal to

For example, COL4 ne 'val4'

gt

Greater than

For example, COL4 gt 'val4'

ge

Greater than or equal

For example, COL4 ge 'val4'

lt

Less than

For example, COL4 lt 'val4'

le

Less than or equal

For example, COL4 le 'val4'

and

Logical and

For example, COL1 eq 'value1' and COL2 ne 'value2'

or

Logical or

For example, COL1 eq 'value1' or COL2 ne 'value2'

not

Logical negation

Create conditions for filtering with any of the following functions:

Query Functions Description
startswith

For example, $filter=startswith(account_name,'Aternity')

endswith

For example, $filter=endswith(account_name,'Aternity')

contains

$filter=contains(COL5,'val5')

For example, $filter=contains(account_name,'Aternity')

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'))
$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_Name,Application_Version,Device_Days_From_Last_Boot,Device_ID_Mobile_Or_Mac,Device_Manufacturer,Device_Memory,Device_Model,Device_Name,Device_Type,Mobile_SDK_Version,OS_Family,OS_Name,OS_Version,Username