v2
latestSwagger 2.02026-07-13103553.7 KBDetect anomalies for the entire series in batch.
This operation generates a model with an entire series. Each point is detected with the same model. With this method, points before and after a certain point are used to determine whether it's an anomaly. The entire detection can give the user an overall status of the time series.
Request body
A custom interval is used to set a nonstandard time interval. For example, if the series is 5 minutes, the request can be set as {"granularity":"minutely", "customInterval":5}.
Argument that indicates the periodic value of a time series. If the value is null or is not present, the API determines the period automatically.
Argument that indicates an advanced model parameter. It's the maximum anomaly ratio in a time series.
Argument that indicates an advanced model parameter between 0 and 99. The lower the value is, the larger the margin value is, which means fewer anomalies will be accepted.
Specifies the value to fill. It's used when granularity is not "none" and imputeMode is "fixed".
Response
The request has succeeded.
Frequency extracted from the series. Zero means no recurrent pattern has been found.
Expected value for each input point. The index of the array is consistent with the input series.
Upper margin of each input point. UpperMargin is used to calculate upperBoundary, which is equal to expectedValue + (100 - marginScale)*upperMargin. Anomalies in the response can be filtered by upperBoundary and lowerBoundary. Adjusting the marginScale value can help filter less significant anomalies on the client side. The index of the array is consistent with the input series.
Lower margin of each input point. LowerMargin is used to calculate lowerBoundary, which is equal to expectedValue - (100 - marginScale)*lowerMargin. Points between the boundary can be marked as normal ones on the client side. The index of the array is consistent with the input series.
Anomaly properties for each input point. True means an anomaly (either negative or positive) has been detected. The index of the array is consistent with the input series.
Anomaly status in a negative direction for each input point. True means a negative anomaly has been detected. A negative anomaly means the point is detected as an anomaly and its real value is smaller than the expected one. The index of the array is consistent with the input series.
Anomaly status in a positive direction for each input point. True means a positive anomaly has been detected. A positive anomaly means the point is detected as an anomaly and its real value is larger than the expected one. The index of the array is consistent with the input series.
Severity score for each input point. The larger the value is, the more severe the anomaly is. For normal points, the severity is always 0.