Analyze Device Health Events (Beta) with REST API (version 1.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

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.

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

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

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

Health_Event_Memory_Consumed,Health_Event_Memory_Utilization,Last_Occurrence,Volume

Attributes

Account_ID,Account_Name,Application,Business_Location,Change_Pilot_Group,Channel,CPU_Cores,CPU_Frequency,CPU_Generation,CPU_Model,CPU_Type,Custom_Attribute_1 - 6,Days_From_Last_Boot,Device_Manufacturer,Device_Model,Health_Event_Category,Health_Event_Component,Health_Event_Component_and_Version,Health_Event_Component_Type,Health_Event_Component_Version,Health_Event_Details,Health_Event_Error,Health_Event_Exception_Type,Health_Event_Manufacturer_Name,Health_Event_Memory_Type,Health_Event_Name,Health_Event_Severity,Health_Event_Stack,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,Image_Build_Number,IP_Address,Max_Timestamp,Line_Of_Business,Location_City,Location_Country,Location_Region,Location_State,Machine_Power_Plan,Market,Memory_Size,Mobile_Device_ID,MS_Office_License_Type,MS_Office_Version,On_Site,On_VPN,OS_Architecture,OS_Disk_Type,OS_Family,OS_Name,OS_Version,Serving_Device_Name,Serving_Device_Type,Store_ID,Store_Type,Subnet,Timeframe,User_Department,User_Domain,User_Email_Address,User_Full_Name,User_Office,User_Role,User_Title,Username,Wifi_BSSID,Wifi_Channel,Wifi_SSID