Component schema

CheckThresholdBaseline

object1 direct reference

Definition

Adaptive baseline detector configuration. Its presence on CheckThresholds re-interprets degraded and failed as z-score cutoffs against the check rule's own predicted value and typical spread.

AnomalyDirectionrequired

Which deviations from the prediction fail the check. For a hand-written expression there is no parsedExpression and therefore no thresholdComparator, so this is the sole source of truth for directionality.

"both""above""below"

number

Optional minimum seasonal spread, expressed as a fraction of the prediction. The server default is used when omitted. For example, 0.05 makes a sensitivity cutoff of 3 require at least a 15% deviation when the measured spread is smaller.

number

Optional minimum predicted volume required for the detector to evaluate. The unit is the observed quantity's unit, so suitable values depend on the selected signal.

Used by 1

These schemas and endpoints reference this type directly.

SchemaCheckThresholds

json

OpenAPI source1234567891011121314151617181920212223242526
{
  "description": "Adaptive baseline detector configuration. Its presence on `CheckThresholds` re-interprets\n`degraded` and `failed` as z-score cutoffs against the check rule's own predicted value and\ntypical spread.\n",
  "properties": {
    "direction": {
      "$ref": "#/components/schemas/AnomalyDirection",
      "description": "Which deviations from the prediction fail the check. For a hand-written expression there\nis no `parsedExpression` and therefore no `thresholdComparator`, so this is the sole\nsource of truth for directionality.\n"
    },
    "spreadFloor": {
      "description": "Optional minimum seasonal spread, expressed as a fraction of the prediction. The server\ndefault is used when omitted. For example, `0.05` makes a sensitivity cutoff of `3`\nrequire at least a 15% deviation when the measured spread is smaller.\n",
      "type": "number",
      "format": "double",
      "minimum": 0,
      "exclusiveMinimum": true
    },
    "volumeFloor": {
      "description": "Optional minimum predicted volume required for the detector to evaluate. The unit is\nthe observed quantity's unit, so suitable values depend on the selected signal.\n",
      "type": "number",
      "format": "double",
      "minimum": 0,
      "exclusiveMinimum": true
    }
  },
  "required": [
    "direction"
  ]
}