Request interface
An interface representing Request.
Properties
| custom |
Custom Interval is used to set non-standard time interval, for example, if the series is 5 minutes, request can be set as {"granularity":"minutely", "customInterval":5}. |
| granularity | Possible values include: 'yearly', 'monthly', 'weekly', 'daily', 'hourly', 'minutely', 'secondly' |
| max |
Optional argument, advanced model parameter, max anomaly ratio in a time series. |
| period | Optional argument, periodic value of a time series. If the value is null or does not present, the API will determine the period automatically. |
| sensitivity | Optional argument, advanced model parameter, between 0-99, the lower the value is, the larger the margin value will be which means less anomalies will be accepted. |
| series | Time series data points. Points should be sorted by timestamp in ascending order to match the anomaly detection result. If the data is not sorted correctly or there is duplicated timestamp, the API will not work. In such case, an error message will be returned. |
Property Details
customInterval
Custom Interval is used to set non-standard time interval, for example, if the series is 5 minutes, request can be set as {"granularity":"minutely", "customInterval":5}.
customInterval?: undefined | numberProperty Value
undefined | number
granularity
Possible values include: 'yearly', 'monthly', 'weekly', 'daily', 'hourly', 'minutely', 'secondly'
granularity: GranularityProperty Value
maxAnomalyRatio
Optional argument, advanced model parameter, max anomaly ratio in a time series.
maxAnomalyRatio?: undefined | numberProperty Value
undefined | number
period
Optional argument, periodic value of a time series. If the value is null or does not present, the API will determine the period automatically.
period?: undefined | numberProperty Value
undefined | number
sensitivity
Optional argument, advanced model parameter, between 0-99, the lower the value is, the larger the margin value will be which means less anomalies will be accepted.
sensitivity?: undefined | numberProperty Value
undefined | number
series
Time series data points. Points should be sorted by timestamp in ascending order to match the anomaly detection result. If the data is not sorted correctly or there is duplicated timestamp, the API will not work. In such case, an error message will be returned.
series: Point[]Property Value
Point[]