Analyze Activities Per Hour with REST API (version 2.0)

BUSINESS_ACTIVITIES_HOURLY returns the list of activities which each user performed in a one-hour time slot (from o'clock to o'clock), along with the activity's average performance (response time) the application name, user details and device details.

Each returned entry from BUSINESS_ACTIVITIES_HOURLY represents the average response time (Activity_Response_Avg) and status (Detection_Status) of one Activity performed one or more times (Volume) in a one hour slot (starting at Timeframe). Therefore if the same user on the same device performs the same activity twice within the same slot, it aggregates them to return a single entry for both those actions, where that entry would have a Volume of 2. 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.

Activity response is the time an application takes to perform the activity

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.

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

Note

This article covers the latest REST API version. For older version 1.0, click here.

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 Aternity REST API, enter the base URL from Aternity > User icon > REST API Access, followed by the name of the API into a browser, Excel or PowerBI (learn more). For VIEWING, use <base_url>/latest/API_NAME; for INTEGRATIONS, use <base_url>/<version number>/API_NAME (for example, <base_url>/v1/API_NAME, or <base_url>/v1.0/API_NAME, or <base_url>/v2/API_NAME, or <base_url>/v2.0/API_NAME).

Get the latest REST API version for analyzing in the external app
:
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_HOURLY

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

.../BUSINESS_ACTIVITIES_HOURLY? select=Activity_Name,Application_Name,Application_Type,Application_Version,Browser,Business_Location,Device_Days_From_Last_Boot,Location_City,Location_Country,Location_Region,Location_State,Device_Network_Type,On_Site,On_VPN,OS_Architecture,OS_Disk_Type,OS_Name,OS_Version,Server_Hostname,Server_IP,Server_Name,Device_Type,User_Department,Activity_Response_Time_Avg,Activity_Client_Time_Avg,Activity_Detection_Status,Activity_Network_Time_Avg,Activity_Backend_Time_Avg,Activity_Volume&$filter=relative_time(last_24_hours)

To view an hourly summary of the response time of each user in Los Angeles when they open a mail in Microsoft Outlook, enter:

.../BUSINESS_ACTIVITIES_HOURLY?$select=ACTIVITY_RESPONSE_TIME_AVG,USERNAME&$filter=ACTIVITY_NAME eq 'Open Mail' and contains(LOCATION_CITY,'Los Angeles')

To plot a graph of the hourly performance trend of a single user opening mail in the past week in Microsoft Outlook, enter:

.../BUSINESS_ACTIVITIES_HOURLY?$select=ACTIVITY_RESPONSE_TIME_AVG,TIMEFRAME&filter=relative_time(last_week) and USERNAME eq 'louise_mangan'

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.

Query Options Description
$select=

Use $select to return only specific columns (attributes), to make queries more efficient: ...API_NAME?$select=COL1,COL2,COL3

$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

$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 for filtering with any of the following operators:

Query Operators Description
eq

Equal to

For example, COL4 eq 'val4'

ne

Not equal to

For example, COL4 ne 'val4'

gt

Greater than

For example, COL4 gt 'val4'

ge

Greater than or equal

For example, COL4 ge 'val4'

lt

Less than

For example, COL4 lt 'val4'

le

Less than or equal

For example, COL4 le 'val4'

and

Logical and

For example, COL1 eq 'value1' and COL2 ne 'value2'

or

Logical or

For example, COL1 eq 'value1' or COL2 ne 'value2'

not

Logical negation

Create conditions for filtering with any of the following functions:

Query Functions Description
startswith

For example, $filter=startswith(account_name,'Aternity')

endswith

For example, $filter=endswith(account_name,'Aternity')

contains

$filter=contains(COL5,'val5')

For example, $filter=contains(account_name,'Aternity')

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'))
$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 BUSINESS_ACTIVITIES_HOURLY represents the average response time (Activity_Response_Avg) and status (Detection_Status) of one Activity performed one or more times (Volume) in a one hour slot (starting at Timeframe). Therefore if the same user on the same device performs the same activity twice within the same slot, it aggregates them to return a single entry for both those actions, where that entry would have a Volume of 2. 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 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.

An example of the data returned by this API viewed in Excel

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

Activity_Backend_Time_Avg,Activity_Client_Time_Avg,Activity_Network_Time_Avg,Activity_Remote_Display_Latency_Avg,Activity_Response_Time_Avg,Activity_Volume,Network_Incoming_Traffic_Total, Network_Outgoing_Traffic_Total,Network_RTT_Avg,Page_Load_DNS_Time_Avg,Page_Load_Processing_Time_Avg,Page_Load_Redirect_Time_Avg,Page_Load_Request_Time_Avg,Page_Load_Response_Time_Avg,Page_Load_TCP_Connect_Time_Avg,Page_Load_Time_Avg

Attributes

Account_ID,Activity_Additional_Info1, Activity_Additional_Info2,Activity_Detection_Status,Activity_Name,Activity_Page_Title,Application_Name,Application_Type,Application_Version,Browser,Business_Location,Calendar_Date,Calendar_Month,Calendar_Week,Client_Device_Name,Client_Device_Type,Corp_Channel,Corp_Line_Of_Business,Corp_Market,Corp_Store_ID,Corp_Store_Type,Custom_Attribute_1 - 6,Custom_Pilot_Group,Data_Center_Business_Location,Device_CPU_Cores,Device_CPU_Frequency,Device_CPU_Generation,Device_CPU_Model,Device_CPU_Type,Device_Days_From_Last_Boot,Device_ID_Mobile_Or_Mac,Device_Image_Build_Number,Device_Manufacturer,Device_Memory,Device_Model,Device_Name,Device_Network_Type,Device_Power_Plan,Device_Subnet,Device_Type,Location_City,Location_Country,Location_On_Site,Location_On_VPN,Location_Region,Location_State,Mobile_Carrier,MS_Office_License_Type,MS_Office_Version,OS_Architecture,OS_Disk_Type,OS_Family,OS_Name,OS_Version,Page_Load_HTTP_Status_Code,Server_Hostname,Server_IP,Server_Name,SLA_Status,Timeframe,User_Department,User_Domain,User_Email_Address,User_Full_Name,User_Office,User_Role,User_Title,Username,Virtualization,Wifi_BSSID,Wifi_Channel,Wifi_SSID,Account_Name