Building API
Description
Use this API to get a list of all buildings under your client tree. This information is returned in JSON format, including the buildings’ ID, location, and square footage. On the GUI, this information can be viewed by navigating the building dashboard and edited by following the steps here.
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 Parameter
| Key | Value | Description | |
| page_size | Optional | 100 | Kaizen’s API uses pagination, by default the page size is set to 50. To change the number of pages per query, set this field to the required number. The maximum size of the page is 1000. |
| page_number | Required for queries with count>page_size | 3 | If the number of buildings is greater than the page size, to reach all the buildings, use page number to reach all points. |
Query URL
For the Central Server, please use the following URL:
https://kaizen.coppertreeanalytics.com/api/v3/buildings?page_size=100&page=1
For the East Server, please use the following URL:
https://kaizen-east.coppertreeanalytics.com/api/v3/buildings?page_size=100&page=1
If you want to drill down on a particular building and only receive information about that building, the building id can be added as a resource parameter. Click here if you want to know how to get the building ID. The final query can be written as
https://kaizen.coppertreeanalytics.com/api/v3/buildings/<building_id>/
For the East Server, this can be written as:
https://kaizen-east.coppertreeanalytics.com/api/v3/buildings/<building_id>/
Response
The results from the query are in JSON format.
| Field Name | Description |
| meta | Contains pagination data, the total count of results, the current page number, the page size, and the total number of pages |
| results | This contains the building information, the kaizen URL for the building, its ID, the location information and the square footage. |
| links | Contains URLs for the first page, the last page and the next page of the query. |
Related Queries
The building ID can be used to drill down and get the systems, insights or trendlogs in the building.