Charts/CreateChart

Both of these fields must be used together, meaning that you cannot just specify one or the other.

To set a relative date range, use the period (see below) property instead.

• OneDay
• FiveDays
• OneMonth
• ThreeMonths
• SixMonths
• OneYear
• All

For example, FiveDays returns the data from the last five days.

Use one of the values below:

• Minutes
• Hours
• Days
• Weeks
• Quarters
• Years

For example, Hours returns the data aggregated per hour.

Timezones are relevant for aggregation because the same data will be aggregated differently, based on which timezone is used. If you aggregate per day, the same data point can be in different days based on which timezone is used.

For a list of timezones, see –

https://en.wikipedia.org/wiki/List_of_tz_database_time_zones

Example:

“timezone”:”Asia/Jerusalem”

Each series can have different inputs (Device, for example), different aggregation and a different time range.

For example, one series can be the average temperature per month from a temperature sensor and a second series could be the energy consumption of an HVAC system.

The definitions in a Chart (such as, startDate/endDate [described above]) override the definition of a series. Therefore, if you would like to specify a different value for the startDate/endDate of each series, then define them for each Series (described below) and do not define them for the Chart (in the fields described above).

Note ‒ This ID is different than the other IDs in Axonize because this ID is defined by you and is not automatically assigned by Axonize.

The response to the CreateChart endpoint will contain data for each series.

This identifier enables you to recognize the data returned in the response for this series.

The series that are returned in the response do not appear in the same order as defined in the request. However, they can be identified by finding this ID in the response.

• Sum
• Average
• Count
• Min
• Maximum
• Terms – Count By Value (Group By)
• Raw – No aggregation
• Duration

In inputType, specify the entity ID type. Use one of the following values –

• DeviceId
• ProductId
• AppId
• GroupId

In inputID, specify the actual ID value.

For example, if an HVAC has both the target temperature and the actual temperature, you may want to use only an actual temperature. On the other hand, if you are looking at a refrigeration room that has three different temperature readings from different parts of the room, you may want them all averaged together.

• AnomalyDetection
• LinearForecast
• QuadraticForecast

• Yesterday
• LastWeek
• LastMonth
• LastYear
• Last7Days
• Last30Days
• Last90Days
• Last24Hours
• Custom

For example –

The quantity of series returned in the response may be larger than the quantity of series requested. This depends on the data type of the events that are being queried. For example, if a count of a non‑numeric data type is being queried (such as engine status – on, off, flooded), then the quantity of each engine status (reading) is provided as a data point (meaning three series are returned – one for each status).

Note ‒ This is not the same series object as in the createChart response.

Each data point specifies the value on the X and Y axes.

Data points are an array –

• The first value of each data point is the total milliseconds from 1970 January 1^st, which is called Unix Time (UTC).
• The second value of each data point is the actual numeric value to be shown in the chart or to be used for calculation.

For example –

The series/categories property is not filled with the raw values, but instead uses the events/valueRange/allowedValues property in Products to convert it to show how this value appears in the Axonize Portal. For example, this identifier could be used to convert the value 0 so that it appears as Closed in the Axonize Portal and the value 1 as Open.

The series/categories property requests that the values that are returned will be after conversion (meaning the display values of the allowed value range), such as Closed and Open instead of 0 and 1.

For example, if the data array looks like that below –

“: [

[

1530748800000,

1.40

],

[

1530835200000,

3.97

],

[

1530921600000,

66666665

],

[

1531008000000,

55552.42

],

[

1531094400000,

5.08

],

[

1531180800000,

4.77

}

]

.

.

.

.

.

Then, the anomalyIndices looks as follows – [2,3]

The anomalyIndices result above indicates two anomalies. The algorithm starts counting from the top from 0. The third data point in the example above is one of the two anomalies, because it is very long (66666665). 2 represents the sequential number of the anomaly, counting from the top.

The fourth data point in the example above is the second anomaly (3). Therefore, for this example, the anomalyIndices property result is [2,3].

A Range has two properties – Min and Max, which specify the start of the range and the end of the range.

Because this is not necessarily linear (for example, when forecasting missing data points), then each consecutive forecast point will be declared by its own range. Currently, Axonize only returns a single range and only supports future forecasting.

For example, if the actual data sent by the device is [2,3,4,5,6] and you requested a forecast, then the chart response data might look as follows –

[

1530748800000,

2

],

[

1530835200000,

3

],

[

1530921600000,

4

],

[

1531008000000,

5

],

[

1531094400000,

6

],

[

1531180800000,

7

],

[

1531267200000,

8

],

[

1531353600000,

9

]

In this case, the forecast ranges look as follows –

[{

“min”:5,”max”:7}]

For this example, the device actually sent [2,3,4,5,6] and the algorithm calculated [7,8,9]. In this case, [7,8,9] indicates what the future values would look like based on the current trend/pattern. These are calculated values only and were not sent by the device. The result shows you the range, but not every data point. For this example, the range of calculated data points (when counting starting from 0 at the top) begins at index 5 and ends at index 7.

A plotline is typically a dashed line drawn parallel with the axis on a chart. A plotline typically shows a minimum or a maximum threshold.