Target / Budget

YAML type: target | Category: Business

Compares actuals to explicit business targets (static or variable monthly).

Description

Target compares series values to configured budgets/KPIs. Weekly/monthly modes evaluate period aggregates (aggregateMode). Optional where scopes which series participate; omitting matchBy implies rollup-only matching.

How it works

Target / Budget illustration

Target compares actuals to configured budgets or KPIs. Daily modes compare point-wise; weekly and monthly modes first aggregate with aggregateMode, then compare to the period target within tolerancePct.

where / matchBy control which series participate (rollup-only matching when matchBy is omitted). valuesBy and monthlyValues override the fallback value for scoped or calendar-varying targets.

Setup

Pick targetMode, provide value / valuesBy / monthlyValues, and set tolerancePct. Limit evaluation with historyDays.

Configure detectors on the data view Analysis tab or in YAML. Validate with Data Preview before enabling production schedules.

Settings

Parameter	Description
`targetMode`	Target schedule -- see Allowed values
`aggregateMode`	Period aggregation -- see Allowed values
`historyDays`	Evaluation window (e.g. 365)
`mode`	Direction -- see Allowed values
`tolerancePct`	Allowed % band around target
`value`	Fallback target
`valuesBy`	Per-dimension overrides
`monthlyValues`	Month keys for variable monthly
`where`	Scope filter
`matchBy`	Optional match grain

Allowed values

`targetMode`

Value	Meaning
`static_daily`	Fixed daily target from `value` / `valuesBy`
`static_weekly`	Fixed weekly target; detection uses week aggregates
`static_monthly`	Fixed monthly target; detection uses month aggregates
`variable_monthly`	Month-varying targets from `monthlyValues` (`MM` or `yyyy-MM` keys)

`aggregateMode`

Used when the detector compares period totals (week / month / quarter), not raw daily points.

Value	Meaning
`sum`	Compare sums of daily values in the period (default)
`average`	Compare averages of daily values in the period

aggregateMode matters for static_weekly, static_monthly, and variable_monthly (period aggregation). For weekly/monthly modes with average, the target is compared to the period average (target is scaled by days in period as implemented by the detector).

`mode`

Value	Meaning
`above`	Flag increases / values above the comparison (or high side of a band)
`below`	Flag decreases / values below the comparison (or low side of a band)
`both`	Flag either direction

Direction is relative to the target band defined by tolerancePct.

Shared series filters

Most detectors also accept optional series filters in params:

Parameter	Purpose
`maxGapAmount`	Skip series when gap amount is too high (`null` = no limit). Catalog create-default is often `5`.
`minValue`	Skip series whose average value is below this (`null` = no limit). Catalog create-default is often `1000`.
`maxValue`	Skip series whose average value is above this (optional; omit/`null` = no limit)
`useSpecialDates`	When `true`, suppress anomalies that overlap special dates

When a filter skips a series, Data Preview shows the reason.

Configuration example

analysis:
  detectors:
    - type: target
      params:
        where:
          region: [SK, CZ, PL]
        targetMode: static_monthly
        aggregateMode: sum
        historyDays: 365
        mode: both
        tolerancePct: 5.0
        valuesBy:
          region:
            SK: 5000
            CZ: 3000
        value: 4000

Using the detector

Data Preview shows daily raw data and aggregated processed series for weekly/monthly modes.

Use cases

Budget vs actuals
Regional sales targets
Capacity or SLA floors

Specifics

If where is set and matchBy omitted, target runs only on matching rollup series.