View Current NOC Scores with REST API (version 1.0)

API_NOC_APPLICATION_CURR_SCORE is for companies who want to display Aternity data in their NOC systems. The API 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 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>/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=Location,Application_Name,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 .../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

API_NOC_APPLICATION_CURR_SCORE is for companies who want to display Aternity data in their NOC systems. The API 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

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_ID,Account_Name,Application_Name,Application_Type,Department,Location,Max_Timestamp,Region