Skip to main content
Version: 1.0.0-beta

Field Reference — Monitoring

KRI Fields​

FieldTypeRequiredDescription
idIntegerAutoUnique identifier
titleString✅KRI display name
descriptionString✅What this KRI measures
query_definitionString✅SQL or logic that computes the metric
threshold_valueFloat✅Critical threshold level
current_valueFloatAutoLatest computed value
owner_idString✅User responsible for this KRI
frequencyString✅DAILY, WEEKLY, MONTHLY, QUARTERLY
categoryString✅OPERATIONAL, FINANCIAL, COMPLIANCE, STRATEGIC
kri_statusStringAutoDRAFT, VALIDATED, PUBLISHED, ARCHIVED
validated_byStringAutoUser who validated
validated_atDateTimeAutoValidation timestamp
published_byStringAutoUser who published
published_atDateTimeAutoPublish timestamp
universe_item_idIntegerOptionalLinked audit universe entity
risk_library_idIntegerOptionalLinked risk library item
pipeline_definitionJSONOptionalVisual pipeline configuration
is_activeBoolean✅Whether actively monitored (default: true)
last_run_atDateTimeAutoLast execution time
next_run_atDateTimeAutoNext scheduled run
cron_expressionStringOptionalCustom cron schedule
org_idIntegerAutoOrganization for data isolation

Alert Fields​

FieldTypeRequiredDescription
idIntegerAutoUnique identifier
kri_idIntegerAutoKRI that triggered the alert
severityStringAutoHigh, Medium, Low
messageStringAutoAlert description
statusStringAutoOPEN, ACKNOWLEDGED, RESOLVED
owner_idStringOptionalAssigned user for investigation
created_atDateTimeAutoWhen alert was triggered
resolved_atDateTimeAutoWhen alert was resolved

Dashboard Metric Fields​

FieldTypeDescription
idIntegerUnique identifier
metric_nameStringMetric display name
valueFloatComputed metric value
dimensionsJSONDimensional keys (e.g., {bu_id: 1, year: 2024})
computed_atDateTimeWhen the metric was computed
job_run_idStringTraceability to the job that computed it

Status Transitions​

KRI Lifecycle​

DRAFT → VALIDATED → PUBLISHED → ARCHIVED

Alert Lifecycle​

OPEN → ACKNOWLEDGED → RESOLVED