Trend Log Summary API

Description

The trend log summary endpoint can be used to retrieve trend log data for the entire building instead of an individual trend. All CTLs, MTLs and TLs associated with the building can be retrieved with this call. Click here to learn more about TLs, MTLs and CTLs. This query is paginated and the maximum allowed page size is 1000. By default, the page size is 50.

Query Headers

Key		Value	Description
Authorization	Required	Bearer <access_token>	This is the JWT Token generated by the client_id and client_secret. Click here to know more about how to generate the JWT

Query Parameters

Key		Value Example	Description
paginated	Required	true	Kaizen’s APIs use cursor pagination to call queries. Set this parameter to true to receive paginated data
page_size	Optional	100	This is the length of result per page for the query. By default, this is set to 500, and the maximum number if page_size is 1000
page	Required	1	This is a numeric value and depends on the number of TLs in the building. The pagination field under meta data of the response can be used to know the number of pages in the query.
building	Required	1234	This is the ID of the building under investigation. Click here to know how to get the ID of a building.
format	Optional	json	The API will return value with a specific format.
data	Optional	raw	The API by default return two synthetic data points, one at the beginning of the range, and a second one at the end of the range. If you want to return the raw samples only, you can add this parameter to equal raw.

Query URL

For Kaizen Central Query:

https://kaizen.coppertreeanalytics.com/yana/mongo/trend_log_summary/?paginated=true&page_size=500&page=<page_number>&building=<building_id>
For Kaizen-East Query:
https://kaizen-east.coppertreeanalytics.com/yana/mongo/trend_log_summary/?paginated=true&page_size=500&page=<page_number>building=<building_id>

Response

Field Name	Description
links	Contains URLs for the first page, the last page and the next page of the query.
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 TL information, including the id of the TL, the first date it was collected, the last date of query, the name of the trend log and the source

Related Queries

Trend log series data can be queried as well by using the query outlined here.