Get channel analysis
This API Return readings of specific data-source, Can be used in order to integrate to other BI tools, or in order to manipulate data using other software.
GET
https://api.zira.us/public/system/analysis
Payload example
// Request:
https://api.zira.us/public/system/analysis?systemId=123&interval=1%20days&fromTime=2021-05-01T00:00:00&toTime=2021-05-30T00:00:00
// Response:
{
"data": {
"status": "Active",
"lasts": null,
"kpis": [
{
"name": "Total Volume",
"unit": " Gal(US)",
"group": null,
"value": 2565,
"toDate": "2021-04-07T05:37:02.415589Z",
"compare": "show",
"maxDate": "2021-04-07T05:35:16.669000Z",
"ordinal": "1",
"fromDate": "2021-04-07T00:00:00.000000Z",
"interval": 60,
"description": null,
"comparePositiveIsGood": false
},
...
],
"charts": [
{
"data": [
[
1617753600000,
1104
],
[
1617757200000,
619
],
[
1617760800000,
523
],
[
1617764400000,
84.6
],
[
1617768000000,
29.9
],
[
1617771600000,
204
]
],
"name": "Volume (Gallon)",
"type": "column",
"unit": " Gal(US)",
"color": "#74b3d2",
"group": null,
"toDate": "2021-04-07T05:37:02.415589Z",
"zIndex": 2,
"maxDate": "2021-04-07T05:35:16.669000Z",
"ordinal": "1",
"visible": true,
"fromDate": "2021-04-07T00:00:00.000000Z",
"interval": 60,
"description": null,
"connectNulls": false
},
...
],
"targets": [
{
"name": "pH is too low",
"color": "#ff7c06",
"toDate": null,
"ordinal": 4,
"toValue": null,
"fromDate": null,
"fromValue": 5.5
},
...
],
"version": "v3"
}
}
Query Params
Property | Required | Type | Example | Description |
---|---|---|---|---|
systemId | true | String | "123" | System id can be copied from zira UI |
interval | false | String | 5 minutes" ; "15 minutes" ; "1 hours" ; "1 days | Data aggregation interval |
fromTime | false | String | "2021-01-21T19:32:00" | start timestamp in ISO format |
toTime | false | String | "2021-01-21T19:32:00" | end timestamp in ISO format |