Analyze Activities Per Day with REST API (version 1.0)

BUSINESS_ACTIVITIES_DAILY returns the list of activities which each user performed each day, along with the activity's average performance (response time) the application name, user details and device details.

Each entry from BUSINESS_ACTIVITIES_DAILY represents the average response time (Activity_Response_Avg) and status (Detection_Status) of one Activity performed one or more times (Volume) during a 24 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.

Note

You can access data using this API (retention) going back up to 92 days. If you do not add a relative_time filter, by default it returns data for the past seven 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>/BUSINESS_ACTIVITIES_DAILY

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

.../BUSINESS_ACTIVITIES_ DAILY? 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_Type,User_Department,Activity_Response_Avg,Client_Time_Avg,Detection_Status,Network_Time_Avg,Server_Time_Avg,Volume&$filter=relative_time(last_week)

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

.../BUSINESS_ACTIVITIES_DAILY?$select=ACTIVITY_RESPONSE_AVG,USERNAME&$filter=ACTIVITY eq 'Open Mail' and contains(LOCATION_CITY,'Los Angeles')

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 BUSINESS_ACTIVITIES_DAILY represents the average response time (Activity_Response_Avg) and status (Detection_Status) of one Activity performed one or more times (Volume) during a 24 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 access data using this API (retention) going back up to three months. If you do not add a relative_time filter, by default it returns data for the past 7 days.

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 this API

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_Response_Avg,Client_Time_Avg,Network_Time_Avg,Page_DNS_Time_Avg,Page_Load_Time_Avg,Page_Processing_Time_Avg,Page_Redirect_Time_Avg,Page_Request_Time_Avg,Page_Response_Time_Avg,Page_TCP_Connect_Time_Avg,Server_Time_Avg,Volume

Attributes

Account_ID,Account_Name,Activity,Application,Application_Type,Application_Version,Browser,Business_Location,Calendar_Month,Calendar_Week,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,Detection_Status,Device_Manufacturer,Device_Model,HTTP_Status_Code,Image_Build_Number,Info1, Info2,Line_Of_Business,Location_City,Location_Country,Location_Region,Location_State,Market,Machine_Power_Plan,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,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