How Can We Help?
This section describes the usage of Query APIs to get information on components in HEAL and details on their KPIs.
List Component Sub-types
To get the list of component sub-types for a specific type of a component in an account, use the ‘components’ Query API as follows:
API Name – components
Format – GET /config/accounts/{accountId}/components
Input Parameters
| Type | Name | Description | Schema | Mandatory / Optional |
| Path | accountId | ID or Identifier of an Account | string | Mandatory |
| Query | componentType | Type of a Component | string | Mandatory |
Output Parameters
Output Type: CSV
- Component Sub-type – Sub-type for a component type
- Component Version – Version of a Component
Sample Input
KPI Details for a Component
To get details of supported KPIs for a specific sub type of a component in an account, use ‘componentsKPIs’ Query API as follows:
API Name – componentsKPIs
Format – GET /config/accounts/{accountId}/componentsKPIs
Input Parameters
| Type | Name | Description | Schema | Mandatory / Optional |
| Path | accountId | ID or Identifier of an Account | string | Mandatory |
| Query | componentSubType | Sub Type of a Component | string | Mandatory |
| Query | componentVersion | Version of a Component | string | Mandatory |
Output Parameters
Output Type: CSV
- KPI Type – Type of a KPI (Availability, Metric(Core as per DB), Config watch, File watch)
- KPI Category – Category of a KPI. Example: CPU, Disk IO
- KPI Group Id – Unique ID of a group KPI
- KPI Group Name – Name of a group KPI
- KPI Id – Unique ID of a KPI
- KPI Name – Name of a KPI
- KPI Description – Description of a KPI
Sample Input