Analyze the Raw List of Activities with REST API (version 1.0)

BUSINESS_ACTIVITIES_RAW returns the list of activities as reported to Aternity one by one, showing the detailed user experience of all activities performed. For example, you can check one, several, or all devices, or any whose hostname contains the text mktg, for one user or any combination of users.

Each returned entry from BUSINESS_ACTIVITIES_RAW represents the performance of a single activity (Activity) by a specific user on a specific device, including the status (Detection_Status) and measurement time (Measurement_Time). It also adds the application details, its resource usage at the exact time when the user performed this activity (PRC_ fields), and the device details, including the device's entire resource usage (HRC_ fields) at the exact time of the activity. This information allows you to correlate the resource usage of an activity.

This data is similar to the information displayed in the User Experience dashboard (learn more).

The Monitor User Experience Dashboard
Note

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.

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

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

.../BUSINESS_ACTIVITIES_RAW? select=Activity,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,Server_Hostname,Server_IP,Server_Name,Serving_Device_Name,Serving_Device_Type,User_Department,Username,Activity_Response_Avg,Client_Time_Avg,Detection_Status,Network_Incoming_Traffic_Total,Network_Outgoing_Traffic_Total,Network_Time_Avg,Server_Time_Avg,Volume,Remote_Display_Latency&$filter=relative_time(last_2_hours)

To view each activity from a specific username in the last six hours, along with its response time, application name, and activity status, enter:

.../BUSINESS_ACTIVITIES_RAW?$select=APPLICATION,ACTIVITY,DETECTION_STATUS,TIMEFRAME&$filter=relative_time(last_6_hours) and contains(USERNAME,'jsmith')

To verify whether a small RAM is responsible for slowness when launching Microsoft Outlook, view the RAM on devices where the Launch activity is longer than 3 seconds:

.../BUSINESS_ACTIVITIES_RAW?$select=MEMORY_SIZE,ACTIVITY_RESPONSE&$filter=contains(APPLICATION,'Outlook') and contains(ACTIVITY,'Launch') and ACTIVITY_RESPONSE gt 3

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.

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 BUSINESS_ACTIVITIES_RAW represents the performance of a single activity (Activity) by a specific user on a specific device, including the status (Detection_Status) and measurement time (Measurement_Time). It also adds the application details, its resource usage at the exact time when the user performed this activity (PRC_ fields), and the device details, including the device's entire resource usage (HRC_ fields) at the exact time of the activity. This information allows you to correlate the resource usage of an activity.

You can access data using this API (retention) going back up to 8 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.

Sample output from BUSINESS_ACTIVITIES_RAW

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.

Type Returned columns

Measurements

Activity_Response,HRC_CPU_Util,HRC_Disk_IO_Read,HRC_Disk_IO_Write,HRC_Disk_Queue_Length,HRC_Network_IO_Read,HRC_Network_IO_Write,HRC_Physical_Memory_Util,HRC_Virtual_Memory_Util,Network_Incoming_Traffic_Total, Network_Outgoing_Traffic_Total,Network_RTT_Average,Network_Time,Page_DNS_Time,Page_Load_Time,Page_Processing_Time,Page_Redirect_Time,Page_Request_Time,Page_Response_Time,Page_TCP_Connect_Time,PRC_CPU,PRC_Physical_Memory,PRC_Virtual_Memory,Remote_Display_Latency,

Attributes

Account_ID,Account_NameActivity,Application,Application_Type,Application_Version,Browser,Business_Location,Change_Pilot_Group,Channel,Client_Device_Name,Client_Device_Type,Client_Time,CPU_Cores,CPU_Frequency,CPU_Generation,CPU_Model,CPU_Type,Custom_Attribute_1 - 6,Data_Center_Location,Days_From_Last_Boot,Detection_Status,Device_Manufacturer,Device_Model,Diverse_Value_1 - 3,HTTP_Status_Code,Image_Build_Number,Info1, Info2,IP_Address,Line_Of_Business,Location_City,Location_Country,Location_Region,Location_State,Machine_Power_Plan,Market,Measurement_Time,Memory_Size,Mobile_Carrier,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,Server_Hostname,Server_IP,Server_Name,Server_Time,Serving_Device_Name,Serving_Device_Type,Store_ID,Store_Type,Subnet,Timeframe,Title,User_Department,User_Domain,User_Email_Address,User_Full_Name,User_Office,User_Role,User_Title,Username,Virtualization