Quality API

27 operations. Paths are relative to the API host (http://localhost:5080 in local development). Every operation accepts an OIDC bearer token (Authorization: Bearer …) or a workspace API key (X-Api-Key: keel_live_…); errors are RFC 9457 Problem Details with a code (error codes). Permissions: matrix.

Method	Path	Summary
POST	/api/v1/workspaces/{workspaceId}/quality/assets:run	Run every active rule on a table and its columns (one job per rule).
POST	/api/v1/workspaces/{workspaceId}/quality/custom-sql:validate	Check custom rule SQL: one read-only SELECT/WITH query (no DDL/DML, one statement).
GET	/api/v1/workspaces/{workspaceId}/quality/dashboard	The Data quality page: dimension scorecard, open incidents (with chart series and threshold) and the rule results table.
GET	/api/v1/workspaces/{workspaceId}/quality/incidents	Incidents, open first (open=true: Open and Acknowledged only).
GET	/api/v1/workspaces/{workspaceId}/quality/incidents/{incidentId}	An incident with the rule's recent series against its threshold and the affected metrics.
POST	/api/v1/workspaces/{workspaceId}/quality/incidents/{incidentId}:acknowledge	Acknowledge an open incident: it is assigned to you.
POST	/api/v1/workspaces/{workspaceId}/quality/incidents/{incidentId}:resolve	Resolve an incident by hand (it also resolves itself after consecutive passing runs).
GET	/api/v1/workspaces/{workspaceId}/quality/models/{modelId}/metrics/{metric}/trust	A metric's trust score with its breakdown (upstream data, coverage, governance, freshness).
GET	/api/v1/workspaces/{workspaceId}/quality/results	The rule results table of the dashboard, paged (failures first, then severity, latest run, name).
GET	/api/v1/workspaces/{workspaceId}/quality/rule-target	The rule editor's view of a table: metrics whose trust a failing rule lowers, and its load cadence from stored results (no source query).
GET	/api/v1/workspaces/{workspaceId}/quality/rules	Quality rules with their latest result (filter by status, type, dimension, severity, asset, outcome).
POST	/api/v1/workspaces/{workspaceId}/quality/rules	Define a rule (active at once). Custom SQL must be one read-only query returning the failing rows.
POST	/api/v1/workspaces/{workspaceId}/quality/rules:backtest	Replay a draft rule's threshold over the table's stored results (latest run per day); nothing is run on the source or saved.
POST	/api/v1/workspaces/{workspaceId}/quality/rules:bulk	Accept or reject many suggested rules: listed ids, or every one at or above minConfidence.
POST	/api/v1/workspaces/{workspaceId}/quality/rules:import	Import dbt tests (schema YAML) or Great Expectations suites (JSON), as files or a zip, as rule proposals (origin Imported, file:line evidence) on the scanned tables of a source; checks that do not map are reported. Govern.
POST	/api/v1/workspaces/{workspaceId}/quality/rules:suggest	Suggest rules from the source's latest scan (also runs after every successful scan).
GET	/api/v1/workspaces/{workspaceId}/quality/rules/{ruleId}	One rule with its parameters, evidence and latest result.
PUT	/api/v1/workspaces/{workspaceId}/quality/rules/{ruleId}	Edit a rule's thresholds, severity, dimension, schedule or wording (audited).
POST	/api/v1/workspaces/{workspaceId}/quality/rules/{ruleId}:accept	Accept a suggested rule: it becomes active and runs on its schedule.
POST	/api/v1/workspaces/{workspaceId}/quality/rules/{ruleId}:pause	Pause an active rule (no scheduled runs; excluded from scores).
POST	/api/v1/workspaces/{workspaceId}/quality/rules/{ruleId}:reject	Reject a suggested rule (optionally with a reason); rescans never re-suggest it.
POST	/api/v1/workspaces/{workspaceId}/quality/rules/{ruleId}:resume	Resume a paused rule.
POST	/api/v1/workspaces/{workspaceId}/quality/rules/{ruleId}:run	Run a rule now on its source (Re-run check); poll the job, then read the rule's runs.
GET	/api/v1/workspaces/{workspaceId}/quality/runs	Runs, newest first (optionally of one rule). Failing keys carry key columns only.
GET	/api/v1/workspaces/{workspaceId}/quality/runs/{runId}	One run with its measured value and up to 50 failing rows' keys.
GET	/api/v1/workspaces/{workspaceId}/quality/scorecard	Scorecard (0–100 per DQ dimension, overall, daily trend). asset: workspace | source:{id} | table:{source}/{schema}/{table} | column:{source}/{schema}/{table}/{column} | entity:{model}/{entity} | metric:{model}/{metric} | domain:{name}.
GET	/api/v1/workspaces/{workspaceId}/quality/trust	Stored metric trust scores (updated when an upstream run completes).

RunQualityRulesForAsset

POST /api/v1/workspaces/{workspaceId}/quality/assets:run

Run every active rule on a table and its columns (one job per rule).

Parameter	In	Type	Required	Notes
workspaceId	path	uuid	yes

Request body (application/json): RunAssetRequest

Field	Type	Notes
dataSourceId	uuid
schema	string
table	string

Status	Description	Body
200	OK	RunsAcceptedDto

Response 200: RunsAcceptedDto

Field	Type	Notes
rules	int32
runs	RunAcceptedDto[]

ValidateQualitySql

POST /api/v1/workspaces/{workspaceId}/quality/custom-sql:validate

Check custom rule SQL: one read-only SELECT/WITH query (no DDL/DML, one statement).

Parameter	In	Type	Required	Notes
workspaceId	path	uuid	yes

Request body (application/json): ValidateSqlRequest

Field	Type	Notes
sql	string

Status	Description	Body
200	OK	SqlValidationDto

Response 200: SqlValidationDto

Field	Type	Notes
problems	string[]
valid	boolean

GetQualityDashboard

GET /api/v1/workspaces/{workspaceId}/quality/dashboard

The Data quality page: dimension scorecard, open incidents (with chart series and threshold) and the rule results table.

Parameter	In	Type	Required	Notes
workspaceId	path	uuid	yes

Status	Description	Body
200	OK	QualityDashboardDto

Response 200: QualityDashboardDto

Field	Type	Notes
activeRules	int32
dimensions	DimensionScoreDto[]
openIncidentCount	int32
openIncidents	IncidentDto[]
overall	number?
results	RuleResultDto[]
sources	int32
suggestedRules	int32
totalResults	int32
trend	TrendPointDto[]

ListQualityIncidents

GET /api/v1/workspaces/{workspaceId}/quality/incidents

Incidents, open first (open=true: Open and Acknowledged only).

Parameter	In	Type	Required	Notes
workspaceId	path	uuid	yes
status	query	IncidentStatus	no
open	query	boolean	no
page	query	int32	no
pageSize	query	int32	no

Status	Description	Body
200	OK	PagedResultOfIncidentSummaryDto

Response 200: PagedResultOfIncidentSummaryDto

Field	Type	Notes
hasNext	boolean
items	IncidentSummaryDto[]
page	int32
pageSize	int32
totalCount	int64

GetQualityIncident

GET /api/v1/workspaces/{workspaceId}/quality/incidents/{incidentId}

An incident with the rule's recent series against its threshold and the affected metrics.

Parameter	In	Type	Required	Notes
workspaceId	path	uuid	yes
incidentId	path	uuid	yes

Status	Description	Body
200	OK	IncidentDto

Response 200: IncidentDto

Field	Type	Notes
affectedMetrics	MetricRefDto[]
incident	IncidentSummaryDto
recentRuns	QualityRunDto[]
series	SeriesPointDto[]
threshold	number?
unit	string?

AcknowledgeQualityIncident

POST /api/v1/workspaces/{workspaceId}/quality/incidents/{incidentId}:acknowledge

Acknowledge an open incident: it is assigned to you.

Parameter	In	Type	Required	Notes
workspaceId	path	uuid	yes
incidentId	path	uuid	yes

Status	Description	Body
204	No Content	—

ResolveQualityIncident

POST /api/v1/workspaces/{workspaceId}/quality/incidents/{incidentId}:resolve

Resolve an incident by hand (it also resolves itself after consecutive passing runs).

Parameter	In	Type	Required	Notes
workspaceId	path	uuid	yes
incidentId	path	uuid	yes

Request body (application/json): ResolveIncidentRequest

Field	Type	Notes
note	string?

Status	Description	Body
204	No Content	—

GetMetricTrustScore

GET /api/v1/workspaces/{workspaceId}/quality/models/{modelId}/metrics/{metric}/trust

A metric's trust score with its breakdown (upstream data, coverage, governance, freshness).

Parameter	In	Type	Required	Notes
workspaceId	path	uuid	yes
modelId	path	uuid	yes
metric	path	string	yes

Status	Description	Body
200	OK	TrustScoreDto

Response 200: TrustScoreDto

Field	Type	Notes
band	string
businessName	string?
capped	boolean
computedAt	date-time
coverage	number
failingCritical	boolean
failingRules	FailingRuleDto[]
freshness	number
freshnessLagHours	number?
freshnessMeasured	boolean
governance	GovernanceDto
metric	string
modelId	uuid
modelName	string
score	int32
upstream	UpstreamScoreDto[]
upstreamData	number
upstreamMeasured	boolean

ListQualityRuleResults

GET /api/v1/workspaces/{workspaceId}/quality/results

The rule results table of the dashboard, paged (failures first, then severity, latest run, name).

Parameter	In	Type	Required	Notes
workspaceId	path	uuid	yes
page	query	int32	no
pageSize	query	int32	no

Status	Description	Body
200	OK	PagedResultOfRuleResultDto

Response 200: PagedResultOfRuleResultDto

Field	Type	Notes
hasNext	boolean
items	RuleResultDto[]
page	int32
pageSize	int32
totalCount	int64

GetQualityRuleTarget

GET /api/v1/workspaces/{workspaceId}/quality/rule-target

The rule editor's view of a table: metrics whose trust a failing rule lowers, and its load cadence from stored results (no source query).

Parameter	In	Type	Required	Notes
workspaceId	path	uuid	yes
dataSourceId	query	uuid	yes
schema	query	string	yes
table	query	string	yes
days	query	int32	no

Status	Description	Body
200	OK	RuleTargetDto

Response 200: RuleTargetDto

Field	Type	Notes
dependentMetrics	int32
loadIntervalHours	number?
loads	int32
rowsPerLoad	int64?
runs	int32
typicalLoadTimeUtc	string?

ListQualityRules

GET /api/v1/workspaces/{workspaceId}/quality/rules

Quality rules with their latest result (filter by status, type, dimension, severity, asset, outcome).

Parameter	In	Type	Required	Notes
workspaceId	path	uuid	yes
status	query	RuleStatus	no
type	query	RuleType	no
dimension	query	QualityDimension	no
severity	query	RuleSeverity	no
sourceId	query	uuid	no
schema	query	string	no
table	query	string	no
outcome	query	RunOutcome	no
search	query	string	no
page	query	int32	no
pageSize	query	int32	no

Status	Description	Body
200	OK	PagedResultOfQualityRuleDto

Response 200: PagedResultOfQualityRuleDto

Field	Type	Notes
hasNext	boolean
items	QualityRuleDto[]
page	int32
pageSize	int32
totalCount	int64

CreateQualityRule

POST /api/v1/workspaces/{workspaceId}/quality/rules

Define a rule (active at once). Custom SQL must be one read-only query returning the failing rows.

Parameter	In	Type	Required	Notes
workspaceId	path	uuid	yes

Request body (application/json): CreateRuleRequest

Field	Type	Notes
column	string?
dataSourceId	uuid
description	string?
dimension	QualityDimension?	Defaults to the rule type's dimension (docs/07 §2).
name	string
parameters	RuleParameters?
schedule	string?	Five-field cron in UTC (e.g. 0 2 * * *); null = on demand only.
schema	string
severity	RuleSeverity	One of Info, Warning, Critical
table	string
type	RuleType	One of NotNull, Unique, AcceptedValues, Range, NonNegative, Regex, ReferentialIntegrity, Freshness, RowCountDelta, VolumeAnomaly, DistributionDrift, CustomSql

Status	Description	Body
201	Created	CreatedResponse

Response 201: CreatedResponse

Field	Type	Notes
id	uuid

BacktestQualityRule

POST /api/v1/workspaces/{workspaceId}/quality/rules:backtest

Replay a draft rule's threshold over the table's stored results (latest run per day); nothing is run on the source or saved.

Parameter	In	Type	Required	Notes
workspaceId	path	uuid	yes

Request body (application/json): BacktestRuleRequest

Field	Type	Notes
column	string?
dataSourceId	uuid
days	int32?
parameters	RuleParameters?
schema	string
table	string
type	RuleType	One of NotNull, Unique, AcceptedValues, Range, NonNegative, Regex, ReferentialIntegrity, Freshness, RowCountDelta, VolumeAnomaly, DistributionDrift, CustomSql

Status	Description	Body
200	OK	RuleBacktestDto

Response 200: RuleBacktestDto

Field	Type	Notes
days	int32
latest	number?
latestDay	string?
latestViolated	boolean?
points	BacktestPointDto[]
runs	int32
supported	boolean
threshold	number?
typical	number?
unit	string?
wouldFail	int32

BulkDecideQualityRules

POST /api/v1/workspaces/{workspaceId}/quality/rules:bulk

Accept or reject many suggested rules: listed ids, or every one at or above minConfidence.

Parameter	In	Type	Required	Notes
workspaceId	path	uuid	yes

Request body (application/json): BulkRuleDecisionRequest

Field	Type	Notes
action	RuleDecision	One of Accept, Reject, Pause, Resume
ids	uuid[]?
minConfidence	number?
reason	string?

Status	Description	Body
200	OK	BulkDecisionDto

Response 200: BulkDecisionDto

Field	Type	Notes
decided	int32
skipped	int32

ImportQualityChecks

POST /api/v1/workspaces/{workspaceId}/quality/rules:import

Import dbt tests (schema YAML) or Great Expectations suites (JSON), as files or a zip, as rule proposals (origin Imported, file:line evidence) on the scanned tables of a source; checks that do not map are reported. Govern.

Parameter	In	Type	Required	Notes
workspaceId	path	uuid	yes

Request body (multipart/form-data): object

Status	Description	Body
200	OK	QualityCheckImportDto

Response 200: QualityCheckImportDto

Field	Type	Notes
checks	int32
created	int32
dataSourceId	uuid
existing	int32
format	string
issues	CheckImportIssueDto[]
refreshed	int32
rules	ImportedRuleDto[]
unchanged	int32
unmapped	UnmappedCheckDto[]

SuggestQualityRules

POST /api/v1/workspaces/{workspaceId}/quality/rules:suggest

Suggest rules from the source's latest scan (also runs after every successful scan).

Parameter	In	Type	Required	Notes
workspaceId	path	uuid	yes

Request body (application/json): SuggestRulesRequest

Field	Type	Notes
dataSourceId	uuid

Status	Description	Body
202	Accepted	SuggestionsAcceptedDto

Response 202: SuggestionsAcceptedDto

Field	Type	Notes
jobId	uuid
snapshotId	uuid

GetQualityRule

GET /api/v1/workspaces/{workspaceId}/quality/rules/{ruleId}

One rule with its parameters, evidence and latest result.

Parameter	In	Type	Required	Notes
workspaceId	path	uuid	yes
ruleId	path	uuid	yes

Status	Description	Body
200	OK	QualityRuleDto

Response 200: QualityRuleDto

Field	Type	Notes
asset	string
column	string?
confidence	number
createdAt	date-time
dataSourceId	uuid
decidedAt	date-time?
decidedBy	string?
decisionReason	string?
description	string?
dimension	QualityDimension	One of Completeness, Uniqueness, Validity, Integrity, Timeliness, Consistency, Reasonableness
evidence	QualityEvidenceDto[]
id	uuid
lastOutcome	RunOutcome?
lastRunAt	date-time?
lastSummary	string?
name	string
openIncidentId	uuid?
origin	Origin	One of Discovered, Inferred, LlmSuggested, UserDefined, Imported
parameters	RuleParameters
schedule	string?
schema	string
severity	RuleSeverity	One of Info, Warning, Critical
status	RuleStatus	One of Proposed, Active, Paused, Rejected
table	string
type	RuleType	One of NotNull, Unique, AcceptedValues, Range, NonNegative, Regex, ReferentialIntegrity, Freshness, RowCountDelta, VolumeAnomaly, DistributionDrift, CustomSql

UpdateQualityRule

PUT /api/v1/workspaces/{workspaceId}/quality/rules/{ruleId}

Edit a rule's thresholds, severity, dimension, schedule or wording (audited).

Parameter	In	Type	Required	Notes
workspaceId	path	uuid	yes
ruleId	path	uuid	yes

Request body (application/json): UpdateRuleRequest

Field	Type	Notes
description	string?
dimension	QualityDimension	One of Completeness, Uniqueness, Validity, Integrity, Timeliness, Consistency, Reasonableness
name	string
parameters	RuleParameters?
schedule	string?
severity	RuleSeverity	One of Info, Warning, Critical

Status	Description	Body
204	No Content	—

AcceptQualityRule

POST /api/v1/workspaces/{workspaceId}/quality/rules/{ruleId}:accept

Accept a suggested rule: it becomes active and runs on its schedule.

Parameter	In	Type	Required	Notes
workspaceId	path	uuid	yes
ruleId	path	uuid	yes

Status	Description	Body
204	No Content	—

PauseQualityRule

POST /api/v1/workspaces/{workspaceId}/quality/rules/{ruleId}:pause

Pause an active rule (no scheduled runs; excluded from scores).

Parameter	In	Type	Required	Notes
workspaceId	path	uuid	yes
ruleId	path	uuid	yes

Status	Description	Body
204	No Content	—

RejectQualityRule

POST /api/v1/workspaces/{workspaceId}/quality/rules/{ruleId}:reject

Reject a suggested rule (optionally with a reason); rescans never re-suggest it.

Parameter	In	Type	Required	Notes
workspaceId	path	uuid	yes
ruleId	path	uuid	yes

Request body (application/json): RejectRuleRequest

Field	Type	Notes
reason	string?

Status	Description	Body
204	No Content	—

ResumeQualityRule

POST /api/v1/workspaces/{workspaceId}/quality/rules/{ruleId}:resume

Resume a paused rule.

Parameter	In	Type	Required	Notes
workspaceId	path	uuid	yes
ruleId	path	uuid	yes

Status	Description	Body
204	No Content	—

RunQualityRule

POST /api/v1/workspaces/{workspaceId}/quality/rules/{ruleId}:run

Run a rule now on its source (Re-run check); poll the job, then read the rule's runs.

Parameter	In	Type	Required	Notes
workspaceId	path	uuid	yes
ruleId	path	uuid	yes

Status	Description	Body
202	Accepted	RunAcceptedDto

Response 202: RunAcceptedDto

Field	Type	Notes
jobId	uuid
ruleId	uuid

ListQualityRuns

GET /api/v1/workspaces/{workspaceId}/quality/runs

Runs, newest first (optionally of one rule). Failing keys carry key columns only.

Parameter	In	Type	Required	Notes
workspaceId	path	uuid	yes
ruleId	query	uuid	no
outcome	query	RunOutcome	no
since	query	date-time	no
page	query	int32	no
pageSize	query	int32	no

Status	Description	Body
200	OK	PagedResultOfQualityRunDto

Response 200: PagedResultOfQualityRunDto

Field	Type	Notes
hasNext	boolean
items	QualityRunDto[]
page	int32
pageSize	int32
totalCount	int64

GetQualityRun

GET /api/v1/workspaces/{workspaceId}/quality/runs/{runId}

One run with its measured value and up to 50 failing rows' keys.

Parameter	In	Type	Required	Notes
workspaceId	path	uuid	yes
runId	path	uuid	yes

Status	Description	Body
200	OK	QualityRunDto

Response 200: QualityRunDto

Field	Type	Notes
asset	string
dimension	QualityDimension	One of Completeness, Uniqueness, Validity, Integrity, Timeliness, Consistency, Reasonableness
durationMs	int64
failingCount	int64?
failingKeys	object[]
finishedAt	date-time
id	uuid
keyColumns	string[]
message	string?
observedValue	number?
outcome	RunOutcome	One of Pass, Warn, Fail, Error,
rowCount	int64?
ruleId	uuid
ruleName	string
ruleType	RuleType	One of NotNull, Unique, AcceptedValues, Range, NonNegative, Regex, ReferentialIntegrity, Freshness, RowCountDelta, VolumeAnomaly, DistributionDrift, CustomSql
scheduledFor	date-time?
severity	RuleSeverity	One of Info, Warning, Critical
startedAt	date-time
summary	string
threshold	number?
trigger	QualityRunTrigger	One of Manual, Schedule, Asset
unit	string?

GetQualityScorecard

GET /api/v1/workspaces/{workspaceId}/quality/scorecard

Scorecard (0–100 per DQ dimension, overall, daily trend). asset: workspace | source:{id} | table:{source}/{schema}/{table} | column:{source}/{schema}/{table}/{column} | entity:{model}/{entity} | metric:{model}/{metric} | domain:{name}.

Parameter	In	Type	Required	Notes
workspaceId	path	uuid	yes
asset	query	string	no

Status	Description	Body
200	OK	ScorecardDto

Response 200: ScorecardDto

Field	Type	Notes
asset	string
dimensions	DimensionScoreDto[]
failing	int32
kind	string
label	string
measured	int32
rules	int32
score	number?
tables	string[]
trend	TrendPointDto[]

ListMetricTrustScores

GET /api/v1/workspaces/{workspaceId}/quality/trust

Stored metric trust scores (updated when an upstream run completes).

Parameter	In	Type	Required	Notes
workspaceId	path	uuid	yes
modelId	query	uuid	no

Status	Description	Body
200	OK	MetricTrustDto[]