Retrieve Indicator Data API

You can use the following to get KPI over time statuses.

API Syntax

https://<Gateway Server>/topaz/servicehealth/customers/<Customer Id>/
kpiOverTime?ciIds=<CI ID>&startDate=<Start Date>&endDate=<End Date>

The API uses the following parameters:

• customerId. Customer ID (use 1 for non-HPE SaaS deployment).

• ciId. Mandatory; use comma-separated CI IDs.

• startDate. Mandatory; start time for the KPI status (value representing the date in milliseconds since January 1 1970).

• endDate. Mandatory; end time for the KPI status (value representing the date in milliseconds since January 1 1970).

• kpiId. Optional; use comma separated KPI internal IDs as in the repository UI (default is empty for all KPIs).

The following is an example of the API and its output:

https://omi.example.com/topaz/servicehealth/customers/1/kpiOverTime?
ciIds=0b656ce308022a6739e3e726497fda6a&startDate=1296499370000
&endDate=1296501466000

<kpiStatuses>
    <kpiStatus>
        <ciId>0b656ce308022a6739e3e726497fda6a</entityId>
        <ciDisplayLabel>ATM 1610</ciDisplayLabel>
        <kpiType>6</kpiType>
        <kpiDisplayName>Application Performance</kpiDisplayName>
        <timeStamp>1296499370000</timeStamp>
        <status>20</status>
        <statusDisplayName>OK</statusDisplayName>
        <duration>311000</duration>
    </kpiStatus>
    <kpiStatus>
        <ciId>0b656ce308022a6739e3e726497fda6a</entityId>
        <ciDisplayLabel>ATM 1610</ciDisplayLabel>
        <kpiType>6</kpiType>
        <kpiDisplayName>Application Performance</kpiDisplayName> 
        <timeStamp>1296499681000</timeStamp>
        <status>-2</status>
        <statusDisplayName>No Data</statusDisplayName>
        <duration>1785000</duration>
    </kpiStatus>
    <kpiStatus>
        <ciId>0b656ce308022a6739e3e726497fda6a</entityId>
        <ciDisplayLabel>ATM 1610</ciDisplayLabel>
        <kpiType>6</kpiType>
        <kpiDisplayName>Application Performance</kpiDisplayName> 
        <timeStamp>1296501466000</timeStamp>
        <status>20</status>
        <statusDisplayName>OK</statusDisplayName>
        <duration>13334000</duration>
    </kpiStatus>
    <kpiStatus>
        <ciId>0b656ce308022a6739e3e726497fda6a</entityId>
        <ciDisplayLabel>ATM 1610</ciDisplayLabel>
        <kpiType>7</kpiType>
        <kpiDisplayName>Application Availability</kpiDisplayName> 
        <timeStamp>1296428400000</timeStamp>
        <status>0</status>
        <statusDisplayName>Critical</statusDisplayName>
        <duration>69663000</duration>
    </kpiStatus>
</kpiStatuses>

The output fields are as follows:

Return Codes

The API returns the following return codes:

You can use the following to retrieve the KPIs defined in the system.

API Syntax

https://<Gateway Server>/topaz/servicehealth/customers/<CustomerId>/
repositories/indicators/kpis/<kpiId>

The API uses the following parameters:

• customerId. Customer ID (use 1 for non-HPE SaaS deployment).

• kpiIds. Optional; leave empty for all KPIs (default), or enter a KPI internal ID as in the repository UI, to select a specific KPI.

The following is an example of the API and its output:

https://host.devlab.ad/topaz/servicehealth/customers/1/repositories/
indicators/kpis/

<kpis>
    <kpi>
        <id>1</id>
        <name>Legacy System</name>
    </kpi>
    <kpi>
        <id>1311</id>
        <name>Value</name>
    </kpi>
    <kpi>
        <id>1310</id>
        <name>Exceptions</name>
    </kpi>
</kpis>

The output fields are as follows:

Return Codes

The API returns the following return codes:

You can use the following to retrieve indicator statuses.

API Syntax

https://<Gateway Server>/topaz/servicehealth/customers/<CustomerId>/
repositories/indicators/statuses

The API uses the following parameter:

customerId. Customer ID (use 1 for non-HPE SaaS deployment).

The following is an example of the API and its output:

https://host.devlab.ad/topaz/servicehealth/customers/1/repositories/
indicators/statuses

<targets>
    <target>
        <id>20</id>
    <name>OK</name>
    </target>
    <target>
        <id>15</id>
        <name>Warning</name>
    </target>
    <target>
        <id>10</id>
        <name>Minor</name>
    </target>
    <target>
        <id>5</id>
        <name>Major</name>
    </target>
    <target>
        <id>0</id>
        <name>Critical</name>
    </target>
    <target>
        <id>-1</id>
        <name>Info</name>
    </target>
    <target>
        <id>-2</id>
        <name>No Data</name>
    </target>
    <target>
        <id>-4</id>
        <name>Downtime</name>
    </target>
</targets> 

The output fields are as follows:

Return Codes

The API returns the following return codes: