Analyze the Raw List of Application Performance Reports with REST API (version 1.0)

Use the APPLICATIONS_RAW API to retrieve the raw list of performance reports to Aternity, showing the performance and usage of each discovered application at five minute intervals running on each monitored device.

For example, if a user complains of slow page load times on a web application, you can use APPLICATIONS_RAW and filter for this user with this application name. View the duration of every single page load, and see when performance was slowest, to correlate with other events which may have happened at that time on that computer, or in that location, or with that web server.

Each returned entry from APPLICATIONS_RAW represents a single performance report sent by a device to Aternity. The data contains a snapshot of the performance of one application by a specific user on a specific device, including its UXI, wait time, and hang time. It also adds the device details, user details, and activity times if it is a managed application. 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 14 days. If you do not add a relative_time filter, by default it returns data for the past day.

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

A typical query showing a classic aggregation for this API would be:

.../APPLICATIONS_RAW?$select=Application,Application_Type,Application_Version,Browser,Business_Location,Days_From_Last_Boot,Location_City,Location_Country,Location_Region,Location_State,Network_Type,On_Site,On_VPN,OS_Architecture,OS_Disk_Type,OS_Name,OS_Version,Serving_Device_Type,User_Department,Active_Time,Activity_Client_Time_Avg,Activity_Network_Time_Avg,Activity_Response_Avg,Activity_Score,Activity_Server_Time_Avg,Activity_Volume,Crashes,Errors,Hang_Time,Usage_Time,UXI,UXI_Weight,Wait_Time&$filter=relative_time(last_2_hours)

To see the trend of SalesForce page load times for a specific user, use $select to see the page load time and also the timeframe, so that the query returns each raw measurement per timeframe, rather than a summary of all page loads into a single aggregated value:

.../APPLICATIONS_RAW?$filter=USERNAME eq 'jsmith' and APPLICATION_TYPE eq 'Web' and contains(APPLICATION,'Sales')&$select=PAGE_LOAD_TIME_AVG,TIMEFRAME

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 returned entry from APPLICATIONS_RAW represents a single performance report sent by a device to Aternity. The data contains a snapshot of the performance of one application by a specific user on a specific device, including its UXI, wait time, and hang time. It also adds the device details, user details, and activity times if it is a managed application. 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. If you do not add a relative_time filter, by default it returns data for the past day.

You can view personally identifiable information (PII) in RAW, HOURLY and DAILY aggregations of Aternity's REST APIs, but there is no PII in the DAILY_ANONYMIZED APIs (learn more). There is no PII in any API which has data for longer than three months.

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

Active_Time,Activity_Client_Time_Avg,Activity_Network_Time_Avg,Activity_Response_Avg,Activity_Score,Activity_Server_Time_Avg,Activity_Volume,Crashes,Errors,Hang_Time,Page_Load_Client_Time_Avg,Page_Load_Network_Time_Avg,Page_Load_Server_Time_Avg,Page_Load_Time_Avg,Page_Load_Volume,Performance_Index,Performance_Weight,Usage_Time,UXI,UXI_Weight,Wait_Time

Attributes

Account_ID,Account_Name,Application,Application_Identifier,Application_Type,Application_Version,Browser,Business_Location,Change_Pilot_Group,Channel,Client_Device_Name,Client_Device_Type,CPU_Cores,CPU_Frequency,CPU_Generation,CPU_Model,CPU_Type,Custom_Attribute_1 - 6,Data_Center_Location,Days_From_Last_Boot,Device_Manufacturer,Device_Model,Image_Build_Number,IP_Address,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,Network_Type,On_Site,On_VPN,OS_Architecture,OS_Disk_Type,OS_Name,OS_Version,Remote_Display_Latency,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,Virtualization,Wifi_BSSID,Wifi_SSID