Analyze Daily Device Health Anonymized (no PII) with REST API (version 1.0)

Use DEVICE_HEALTH_DAILY_ANONYMIZED to return the list of health events that occurred each day, without PII (personally identifiable information). For example, you can analyze whether the prevalence of certain types of health events in laptops over the past 200 days has a relationship to the number of CPU cores.

Each entry from DEVICE_HEALTH_DAILY_ANONYMIZED represents health event data aggregated over a day, with additional details exclusive of PII.

Note

You can access data using this API (retention) going back up to 400 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. For LDAP users, enter the domain name, then a backslash ('\'), then your network username and password. For example domain_name\jsmith

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

For example, to return the number of hardware health events health events in laptops over the past 200 days, aggregated by location, number of cores, CPU frequency, and the type of health event, use: .../DEVICE_HEALTH_DAILY_ANONYMIZED?$filter=SERVING_DEVICE_TYPE eq 'Laptop' and relative_time(last_200_days)&$select=BUSINESS_LOCATION,CPU_CORES,CPU_FREQUENCY,HEALTH_EVENT_CATEGORY

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.

Output

Each entry from DEVICE_HEALTH_DAILY_ANONYMIZED represents health event data aggregated over a day, with additional details exclusive of PII. 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 400 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

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_Exception_Type,Health_Event_Manufacturer_Name,Health_Event_Memory_Consumed,Health_Event_Memory_Utilization,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,Image_Build_Number,Line_Of_Business,Location_City,Location_Country,Location_Region,Location_State,Machine_Power_Plan,Market,Memory_Size,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_Office,User_Role,Wifi_BSSID,Wifi_Channel,Wifi_SSID