Analyze Device Health Events (Beta) with REST API (version 2.0)

Use DEVICE_HEALTH_RAW (beta) to view the list of all device health events reported to Aternity up to the last seven days, updated every hour.

For example, you can filter to look for incidents of bad blocks on hard disks, to analyze whether there are widespread hard disk issues.

Each entry from DEVICE_HEALTH_RAW (beta) represents an occurrence of a health event, including its category, sub-category, the component name and version which reported the error, any event details, error code, exception type and so on. If several identical events repeated in one hour, it returns the first of those events. 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 About how long Aternity keeps this data (retention) and how far back you can go, read here.
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. For LDAP users, enter the domain name, then a backslash ('\'), then your network username and password. For example domain_name\jsmith

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
The <base_URL> is configured in the Aternity REST API Server as the external_url (learn more):
http://odata-aternity.company.com:80/aternity.odata/API_NAME
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/DEVICE_HEALTH_RAW or <base_url>/v2/DEVICE_HEALTH_RAW

To view the users who suffered from bad blocks on their hard disks in the past week, enter:

<base_url>/DEVICE_HEALTH_RAW?$filter=relative_time(last_7_days) and contains(health_event_name,'Blocks')&$select=username

To see a summary of the health event names reported in the last 24 hours, view only the health events and their categories, sub-categories:

<base_url>/DEVICE_HEALTH_RAW?$filter=relative_time(last_24_hours)&$select=health_event_category,health_event_sub_category,health_event_name

To see a the health event details of a specific user, filter for for that username or hostname, and select to view key fields for each health event:

<base_url>/DEVICE_HEALTH_RAW?$filter=USERNAME eq 'jsmith@company.com'&$select=health_event_name,health_event_details

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

To limit the timeframe of a query, add $filter=relative_time() like, .../API_NAME?$filter=relative_time(last_x_hours) or (last_x_days). Learn more.

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 DEVICE_HEALTH_RAW (beta) represents an occurrence of a health event, including its category, sub-category, the component name and version which reported the error, any event details, error code, exception type and so on. If several identical events repeated in one hour, it returns the first of those events. 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 92 days. If you do not add a relative_time filter, by default it returns data for the past 7 days.

The API returns two types of columns: Attributes (or dimensions) which are the properties of an entry, and Measurements which are the dynamic measured values. A single API row can display either a single measurement, or a weighted average of several entries grouped together. If you use $select to display several attributes, and all those attributes are identical, it groups them into a single entry.

Type Returned columns

Measurements

Unique_Hourly_Events

Attributes

Account_ID,Application_Name,Business_Location,Calendar_Date,Calendar_Month,Calendar_Week,Corp_Channel,Corp_Line_Of_Business,Corp_Market,Corp_Store_ID,Corp_Store_Type,Custom_Attribute_1 - 9,Custom_Pilot_Group,Device_CPU_Cores,Device_CPU_Frequency,Device_CPU_Generation,Device_CPU_Model,Device_CPU_Type,Device_Days_From_Last_Boot,a_conrefs_odata_columns_v2.html#glossentry_xvb_pwx_rcb_v2,Device_ID_Mobile_Or_Mac,Device_Image_Build_Number,Device_IP_Address,Device_Manufacturer,Device_Memory,Device_Model,Device_Name,Device_Network_Type,Device_Power_Plan,Device_Subnet,Device_Type,Health_Event_Category,Health_Event_Component,Health_Event_Component_and_Version,Health_Event_Component_Type,Health_Event_Component_Version,,,Health_Event_Exception_Type,,Health_Event_Manufacturer_Name,,,,Health_Event_Name,Health_Event_Severity,,Health_Event_Status,Health_Event_Stop_Event_Info,Health_Event_Sub_Category,Health_Event_Sub_Component,Health_Event_Sub_Component_And_Version,Health_Event_Sub_Component_Type,Health_Event_Sub_Component_Version,,Location_City,Location_Country,Location_On_Site,Location_On_VPN,Location_Region,Location_State,Mobile_Carrier,MS_Office_License_Type,MS_Office_Version,MS_Stability_Index,OS_Architecture,OS_Disk_Type,OS_Family,OS_Name,OS_Version,Timeframe,User_Department,User_Domain,User_Email_Address,a_conrefs_odata_columns_v2.html#glossentry_kf5_x3y_rcb_v2,User_Office,User_Role,User_Title,Username,Wifi_BSSID,Wifi_Channel,Wifi_SSID,Account_Name

Additional Text Fields

Health_Event_ErrorHealth_Event_DetailsHealth_Event_Last_TimestampHealth_Event_Memory_ConsumedHealth_Event_Memory_TypeHealth_Event_Memory_UtilizationHealth_Event_StackHealth_Event_Volume

These are special text fields, and not classic measurements. Aternity does not create their aggregations, because they are extremely diverse. Users can bring one of the values (when they bring all fields, they get the value of each row, otherwise it is some function that brings one of them).

Select unique device, unique device name, time of the event and all fields that are relevant and describe the health event you analyze. These fields are meaningful only if to bring all attributes of the health event.