KPIs Information

This section describes the usage of Query APIs to get Workload aka transaction and Behavior-related KPIs information from HEAL. All the time series data is provided as per collection interval frequency.

Behavior KPIs

List Non-Group Behavior KPIs Data

To get time-series data of a Non-Group Behavior KPI for a specific host or component instance, use the ‘non-group-kpi’ Query API as follows:
API Name – non-group-kpi
Format – GET /kpi-data/accounts/{accountId}/instances/{instanceId}/non-group-kpi/{kpiId}

Input Parameters 

Output Parameters
Output Type: CSV

• Time – Timestamp at which KPI value is shown.
• KPI Value – Value for the KPI at a particular time instance.

Sample Input

List Group Behavior KPIs Data

To get time-series data of a Group KPI for a specific host or component instance, use the ‘group-kpi’ Query API as follows:
API Name – group-kpi
Format – GET /kpi-data/accounts/{accountId}/instances/{instanceId}/group-kpi/{kpiId}/{kpiAttribute}

Input Parameters

Output Parameters
Output Type: CSV

• Time – Timestamp at which KPI value is shown.
• KPI Value – Value for the KPI attribute at a particular time instance.

Sample Input

List Multiple KPIs Data

To get time-series details of the multiple behavior KPIs for a specific host or a component instance, use the ‘multiple-instance-kpi’ Query API as follows:
API Name – multiple-instance-kpi
Format – GET /kpi-data/accounts/{accountId}/instances/{instanceId}/multiple-instance-kpi

Input Parameters

Output Parameters
Output Type: text

• Time (GMT) – Timestamp (date and time in GMT format)
• KPI – Value of a behavior KPI at a particular time instance

Sample Input

List All Attributes Data for Group KPIs

To get time-series details of the multiple behavior KPIs for a specific host or a component instance, use the ‘multiple-instance-kpi/threshold’ Query API as follows. This returns values for all the attributes of a Group KPI if you don’t specify threshold. For a non-group KPI, this returns values of the KPI for a specific time range. If you specify threshold, it returns only the KPI values which are greater than the threshold.
API Name – multiple-instance-kpi/threshold
Format – GET /kpi-data/accounts/{accountId}/instances/{instanceId}/multiple-instance-kpi/threshold

Input Parameters

Output Parameters

Output Type: text

• Date – Timestamp (date and time in GMT format)
• Applications – Applications to which the services belong to.
• Services – Name of the service
• Instance – Name of a host or a component instance
• KPI – Value of a behavior KPI at a particular time instance
• Attribute – NA for a non-group KPI. Name of the attribute for a group KPI.
• Value – Value of the KPI for an instance in time.

Sample Input

Workload KPIs

List Request KPIs Data

To get time-series data of a workload KPI for a specific transaction instance, use the ‘kpi’ Query API as follows:
API Name – kpi
Format – GET /kpi-data/accounts/{accountId}/services/{serviceId}/requests/{requestId}/kpi/{kpiId}

Input Parameters

Output Parameters
Output Type: CSV

• Time – Timestamp at which KPI value is shown.
• KPI Value – Value of a KPI at a particular time instance.

Sample Input

List Request Aggregate Data

To get workload aggregated data for a specific service, use the ‘request-aggregates’ Query API as follows:
API Name – request-aggregates
Format – GET /kpi-data/accounts/{accountId}/services/{serviceId}/request-aggregates

Input Parameters

Output Parameters
Output Type: CSV

• Request Id – Unique ID of a request
• Request Name – Name of a request
• Tags – Tag of a request. You may tag a request and use the tag as a filter in workload dashboard.
• Volume – Total number of such requests
• Success Count – This displays the total number of success requests.
• Success Percentage – This displays percentage of successful requests.
• Failed Count – This displays count of failed requests.
• Failed Percentage – This displays percentage of failed requests.
• Slow Count – This displays percentage of slow requests.
• Slow Percentage – This displays percentage of slow requests.

Sample Input

List Multiple Request KPIs Data

To get time-series details of the multiple workload KPIs for a specific request, use the ‘multiple-request-kpi’ Query API as follows:
API Name – multiple-request-kpi
Format – GET /kpi-data/accounts/{accountId}/services/{serviceId}/multiple-request-kpi

Input Parameters

Output Parameters
Output Type: text

• Time (GMT) – Timestamp (date and time in GMT format)
• KPI – Value of a workload KPI at a particular time instance

Sample Input