View Application Events with REST API

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 an Aternity username which has the OData Role privilege, and its password. For SSO users, generate your own Aternity REST API password by selecting User icon > REST API Password. For LDAP users, enter the domain name, then a backslash ('\'), then your network username and password. For example domain_name\jsmith

To view an Aternity REST API, enter the URL: <base_url>/API_NAME from a browser, Excel or PowerBI (learn more). The <base_URL> is configured in the Aternity REST API Server as the external_url (learn more):

http://odata-aternity.company.com:80/aternity.odata/API_NAME
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 .../aternity.odata/API_NAME?$filter=(USERNAME eq 'jsmith@company.com'), or several parameter-value pairs each separated by an ampersand (&), like .../aternity.odata/API_NAME?$format=xml&$top=5.

Parameter Description
$filter=

Use $filter to insert conditions which narrow down the data, to return only entries where those conditions are true. .

Combine several parameters using 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) and le (less than or equal to). You can also use the text operator contains, though it significantly slows the API performance.

Aternity also supports the not operator, which negates the query expression that follows it. For example, .../aternity.odata/API_NAME?$filter=(CLIENT_DEVICE_TYPE eq 'Laptop' or CLIENT_DEVICE_TYPE eq 'Tablet') and not(LOCATION_CITY eq 'Miami' or LOCATION_CITY eq 'Los Angeles') will return data for laptops and tablets for all locations except Miami and Los Angeles. For details on these OData parameters that are supported by Aternity, see Microsoft's OData documentation.

Use the relative_time() filter to easily limit the timeframe of your query. For example, .../aternity.odata/API_NAME?$filter=relative_time(yesterday). Possible values are:

  • last_6_hours: Shows data starting from exactly six hours ago, displaying it summarized (aggregated) according to the view you selected.

  • last_24_hours: Shows data starting exactly this time yesterday, displaying it summarized (aggregated) according to the view you selected.

  • today: Displays data starting from 00:00AM today in the time zone of the Aternity Management Server.

  • yesterday: Displays data starting from 00:00AM yesterday according to the time zone of the Aternity Management Server.

  • last_48_hours: Displays data starting exactly this time two days ago, displaying it summarized (aggregated) according to the view you selected.

  • last_7_days: Displays data starting from 00:00AM seven days ago in the time zone of the Aternity Management Server.

  • this_week: Displays data for this week, beginning from 00:00 AM on Sunday morning according to the time zone of the Aternity Management Server, until the current time.

  • last_week: Displays data from 00:00AM on Sunday morning to 23:59 on the most recent Saturday night according to the time zone of the Aternity Management Server. Use this view to compare consistent weekly results.

  • last_14_days: Displays data from exactly this time 14 days ago, displaying it summarized (aggregated) according to the view you selected.

  • last_30_days: Displays data from exactly this time 30 days ago, displaying it summarized (aggregated) according to the view you selected.

$format=

Use $format to force the returned data to be either in XML or JSON format. This is only useful for programmers or those testing the raw data in a web browser. For example:

.../aternity.odata/API_NAME?$format=xml

$orderby

Use $orderby to order the returned data according to the value you choose. For example, to order results device inventory results based on location, use .../aternity.odata/DEVICE_INVENTORY?$orderby=LOCATION

$select=

Use $select to return only the data of specific columns (attributes). To return several columns, list them separated by a comma (no space).

For example, to return only the application and department, use:

.../aternity.odata/API_NAME?$select=APPLICATION,DEPARTMENT&...

$top=

Use $top (lower case only, not TOP) 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 in any way), use:

.../aternity.odata/API_NAME?$top=5

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,Client_Device_Name,Client_Device_Type,CPU_Cores,CPU_Frequency,CPU_Generation,CPU_Model,CPU_Type,Data_Center_Location,Days_From_Last_Boot,Device_Manufacturer,Device_Model,Event_Category,Event_Details,Event_Type,Location_City,Location_Country,Location_Region,Location_State,Measurement_Time,Memory_Size,Mobile_Carrier,Mobile_Device_ID,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,Subnet,Timeframe,Title,User_Department,User_Domain,User_Email_Address,User_Full_Name,User_Office,User_Role,Username,Virtualization