Insight API

Description

Kaizen triggers insights to notify users of findings. Click here to learn more about insights. You can query for historic insights or active insights. The response includes insight IDs, active since, insight class, insight class name, message, threshold, etc.

This call uses Offset pagination

Query Type

GET

Query Header

Key  Value Description
Authorization Required Bearer access_token_ This Query requires the JWT token. To know how to get JWT token, click here

Query Parameters

Key Value Description
limit Optional 80 This is the size of the response. By default, this is set to 500. The maximum response size is 1000
start Optional 900 This is the position at which the current page starts. By default, this is set to 0.

Query

To query all active insights in the building, locate the building ID using the steps outlined here. Using the building ID as a resource parameter, query the insights using the URL given below.

https://kaizen.coppertreeanalytics.com/yana/rulestate/public-api/v1/insights/<building_id>

For retrieving the insight histories, the query below can be used. The insight ID needs to be passed as a resource parameter. Click here to learn how to fetch the insight-id.

https://kaizen-east.coppertreeanalytics.com/yana/rulestate/public-api/v1/insight-history/<insight_id>

Response

Field Description
limit As this call uses offset pagination, the limit is the current limit set by the call. By default, it is set to 500.
next The next call URL is present in this field. For the last call, it is set to ‘ ‘
previous The previous call URL is present in this field
results This field contains the id of the insight, when the insight was triggered, the insight class, the class name, the message, the system for which the insight was triggered, and the priority id of the insight. Description for Class IDs can be found here.

Related Queries

The response contains the building ID, the system ID the insight is a part of, and the TL information. This can be used to query Building, System or Insight information.