Analyze Device's Resource Usage (HRC) with REST API (Version 1.0)

Use HOST_RESOURCES_HOURLY to view data regarding CPU and memory usage by devices (HRC, not the usage by one application).

For example, if a particular model of laptop uses too much CPU regularly, you can compare that model's resource usage across different business locations and operating systems.

Each entry from HOST_RESOURCES_HOURLY represents one device's resource usage data aggregated over an hour, along with details of that device. 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 31 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>/HOST_RESOURCES_HOURLY

To view the CPU usage of all Thinkpad models across different locations, enter:

.../HOST_RESOURCES_HOURLY?$select=BUSINESS_LOCATION,CPU_UTILIZATION_AVG&$filter=contains(DEVICE_MODEL,'ThinkPad')

To return the list of users and their departments where their devices consumed on average more than 25 percent CPU and did not reboot for over 30 days:

.../HOST_RESOURCES_HOURLY?$select=USERNAME,USER_DEPARTMENT&$filter=CPU_UTILIZATION_AVG gt 25 and DAYS_FROM_LAST_BOOT eq 'More than 30 days'

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 HOST_RESOURCES_HOURLY represents one device's resource usage data aggregated over an hour, along with details of that device. 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 14 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

CPU_Utilization_Avg,Disk_IO_Read_Avg,Disk_IO_Write_Avg,Disk_Queue_Length_Max,Network_Read_Avg,Network_Write_Avg,Physical_Memory_Util_Avg,Virtual_Memory_Util_Avg

Attributes

Account_ID,Account_Name,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_Idle_This_Hour,Device_Manufacturer,Device_Model,Hour_Running_Total,Image_Build_Number,Line_Of_Business,Location_City,Location_Country,Location_Region,Location_State,Market,Machine_Power_Plan,Memory_Size,MS_Office_License_Type,MS_Office_Version,Network_Type,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