Data Quality API Reference
Complete REST API documentation for the Data Quality Service. All endpoints require a valid JWT token with the X-Tenant-ID header for multi-tenant isolation.
Base URL: http://data-quality-service.matih-data-plane.svc.cluster.local:8000/v1/quality
Validation Rules
| Method | Endpoint | Description |
|---|---|---|
| POST | /rules | Create a validation rule |
| GET | /rules | List all rules (filterable by dataset, type, status) |
| GET | /rules/:ruleId | Get rule details |
| PUT | /rules/:ruleId | Update a rule |
| DELETE | /rules/:ruleId | Delete a rule |
| POST | /validate | Execute validation for a dataset |
| GET | /validations/:validationId | Get validation results |
Data Profiling
| Method | Endpoint | Description |
|---|---|---|
| POST | /profiles | Run a profiling job |
| GET | /profiles | List profiles for a dataset |
| GET | /profiles/:profileId | Get profile details |
| GET | /profiles/compare | Compare two profiles (query params: baseline, current) |
| POST | /profiles/schedule | Schedule recurring profiling |
| DELETE | /profiles/schedule/:scheduleId | Remove profiling schedule |
Quality Scores
| Method | Endpoint | Description |
|---|---|---|
| GET | /scores | Get current quality scores (query param: dataset) |
| GET | /scores/trends | Get historical score trends (query params: dataset, days) |
| POST | /sla | Configure SLA thresholds for a dataset |
| GET | /sla | Get SLA configuration for a dataset |
Anomaly Detection
| Method | Endpoint | Description |
|---|---|---|
| POST | /anomalies/configure | Configure anomaly detectors for a dataset |
| GET | /anomalies | List detected anomalies (query params: dataset, severity, type) |
| GET | /anomalies/:anomalyId | Get anomaly details |
| POST | /anomalies/freshness | Configure freshness monitoring |
| PUT | /anomalies/:anomalyId/acknowledge | Acknowledge an anomaly |
Alerts
| Method | Endpoint | Description |
|---|---|---|
| POST | /alerts | Create an alert rule |
| GET | /alerts | List alert rules |
| PUT | /alerts/:alertId | Update an alert rule |
| DELETE | /alerts/:alertId | Delete an alert rule |
| GET | /alerts/history | Get alert firing history |
Common Query Parameters
| Parameter | Type | Description |
|---|---|---|
dataset | string | Dataset identifier (e.g., analytics.sales.transactions) |
limit | int | Maximum results to return (default: 50) |
offset | int | Pagination offset |
status | string | Filter by status (active, inactive) |
severity | string | Filter by severity (critical, warning, info) |
Error Responses
| Status Code | Description |
|---|---|
| 400 | Invalid request body or parameters |
| 401 | Missing or invalid authentication token |
| 403 | Insufficient permissions for the tenant |
| 404 | Resource not found |
| 409 | Conflict (duplicate rule name) |
| 422 | Validation error in request payload |
| 500 | Internal server error |
Authentication
All requests must include:
Authorization: Bearer <jwt-token>
X-Tenant-ID: <tenant-id>Related Pages
- Validation Rules -- Rule type details
- Data Profiling -- Profiling engine details
- Pipeline Service API -- Pipeline management API