View Application Events with REST API (version 1.0)

Use APPLICATION_EVENTS to return application events which report errors or check how often someone used a feature in your application, like accessing the online help. You create an application event in the Aternity Activity Designer and upload it to Aternity as a custom activity.

Each returned entry from APPLICATION_EVENTS contains one reported application event, with its category, details and time (if applicable), along with the application, user and device details.

There are three types of application events (displayed in the Event_Type field):

  • Application Usage Duration is for measuring the time to complete a non-typical complex business activity, like one which includes application response times mixed with time waiting for the user. For example, use this to measure the time required for a user to identify a customer at the beginning of a call.

    The returned Event_Duration field displays the time for the event to complete.

  • Application Usage Event is for counting the times when an event occurred, or when it is not easy to identify the end event of an activity. For example, if you want to track the number of times when people shared their desktop in Skype for Business, track this as an application usage event, and assign a Category to different types of usage events.

  • Application Error Events are for tracking the occurrence of errors. Each error has a Category, or type of error, and a Details field, which contains details of the event or error.

    See the returned Event_Category and Event_Details fields.

Count a custom application event
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>/APPLICATION_EVENTS

To view the users who experienced application events in the last six hours from devices with hard disk drives (not SSDs) in Miami or Los Angeles, that experienced IO write times lower than 10,000 MB/sec, by using this filter:

.../APPLICATION_EVENTS?$select=username&$filter=relative_time(last_6_hours) and OS_DISK_TYPE eq 'HDD' and HRC_DISK_IO_WRITE lt 10000 and (contains(LOCATION_CITY,'Angeles' or LOCATION_CITY eq 'Miami')

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 APPLICATION_EVENTS contains one reported application event, with its category, details and time (if applicable), along with the application, user and device details.

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.

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

Event_Duration

Attributes

Account_ID,Account_Name,Activity,Application,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,Event_Category,Event_Details,Event_Type,Image_Build_Number,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,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