View Current NOC Scores with REST API

API_NOC_APPLICATION_CURR_SCORE is for companies with their own NOC systems and want to display Aternity's data there. It returns activity scores and volumes of each application in each location, in each department within that location. The volumes and scores are for the past five minutes, the past hour and the past 24 hours. 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.

This information is ideal if you have your own internal system which collects all management information from your enterprise (a manager of managers) and presents it in your own custom dashboard.

You can also see this type of information in Aternity in the Monitor NOC dashboard, when you select a single application and then a single location for that application. Hover your mouse over a score to view all the departments in that location.

Relating data from API_NOC_APPLICATION_CURR_SCORE to the NOC dashboard

There are some noteworthy differences between this API's data and the data in the Monitor NOC dashboard:

  • The Now column in the dashboard shows scores for the past 10 minutes, while the API data shows the past five minutes.

  • The Today column shows scores until the previous midnight server time, while the API's _1d parameters show the scores of the previous 24 hours.

  • The dashboard volumes and scores show all departments in a location, while the API separates data per department.

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

To view applications whose activities were slower than five seconds in Microsoft Outlook over the past day, enter:

.../API_NOC_APPLICATION_CURR_SCORE?$select=application_name&$filter=Average_Response_Time_1D gt 5 and Application eq 'Microsoft Outlook'

To see only the location, application name, and the past day's average response time, use:

.../API_NOC_APPLICATION_CURR_SCORE?$select=Business_Location,Application,Average_Response_Time_1D

To return the activity scores of all applications whose name contains 'SAP' activities in all locations, enter:

.../API_NOC_APPLICATION_CURR_SCORE?$filter=contains(Application,'SAP')

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

API_NOC_APPLICATION_CURR_SCORE is for companies with their own NOC systems and want to display Aternity's data there. It returns activity scores and volumes of each application in each location, in each department within that location. The volumes and scores are for the past five minutes, the past hour and the past 24 hours. 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.

Sample output for the API_NOC_APPLICATION_CURR_SCORE

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

Measurement

Age_In_Days,Age_In_Hours,Age_In_Minutes,Average_Response_Time_1d, Average_Response_Time_1h, Average_Response_Time_5min,Critical_Status_Count_1h, Critical_Status_Count_1d, Critical_Status_Count_5min,Major_Status_Count_1h, Major_Status_Count_1d, Major_Status_Count_5min,Minor_Status_Count_1h, Minor_Status_Count_1d, Minor_Status_Count_5min,Normal_Status_Count_1h, Normal_Status_Count_1d, Normal_Status_Count_5min,Score_1d, Score_1h, Score_5min,Volume_1d, Volume_1h, Volume_5min

Attribute

Account_Name,Application,Application_Type,Business_Location,Department,Max_Timestamp,Region