TrendLog Series API
Description:
For a given trend log, its value and the corresponding timestamps can be exported. Before this query can be executed, the API key should be located. The ID of the trendlog also needs to be found. This can be done by following the steps below.
Parameter:
Key | Value Example | Description | |
tl | Required | 1234.12345.TL12 | This is the building id, device id, and Trend Log id of the trend log the data is queried for. The tl can be found by following the steps outlined here. |
start | Required | yyyy-mm-ddThh:mm:ss | The start date of your time range using this format “YYYY-MM-DDTHH:MM:SS”. For example, 2014-03-14T16:43:57 |
end | Required | yyyy-mm-ddThh:mm:ss | the end date of your time range using this format “YYYY-MM-DDTHH:MM:SS”. For example, 2014-03-24T16:43:57 |
api_key | Required | 1234567890abcde | This is the “Coppertree Cloud Key” key found within a user’s profile in Kaizen. It is security to protect your data. The api_key can be found here. |
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
https://kaizen.coppertreeanalytics.com/public_api/api/get_tl_data_start_end?
api_key=<api_key>&tl=<tl_ref>&start=<start_date_in_the_format_given_above>&end=<end_date_in_the_format_given_above>
or
https://kaizen-east.coppertreeanalytics.com/public_api/api/get_tl_data_start_end?
api_key=<api_key>&tl=<tl_ref>&start=<start_date_in_the_format_given_above>&end=<end_date_in_the_format_given_above>
Response:
Field name | Value Example | Description |
ts | yyyy-mm-ddThh:mm:ss | This is the time stamp of the data |
v | 12.34 | This is the value of the trendlog for the corresponding time stamp. |
Related Queries
If the trendlog data needs to be collected for different sites in one place, another similar query linked here can be used.