data_quality

Create Data Quality Check Schedule

Create a new automated data quality check schedule for an asset.

Supports multiple check types:
- **freshness**: Monitor data recency using timestamp columns or row counts
- **statistical**: Run statistical analysis for anomaly detection (future)

The schedule will automatically execute checks based on the specified interval.
post/api/v1/assets/{asset_id}/data-quality/schedules

Request

  • Base URL: http://localhost:8000
  • URL: http://localhost:8000/api/v1/assets/{asset_id}/data-quality/schedules
  • Auth: none declared

Path parameters

asset_idinteger required

Headers

Authorizationstring

Request body

table_pathstring required

Full path to the table to monitor

check_type'freshness' | 'statistical' | 'anomaly' | 'row_count' | 'consistency' | 'custom_sql' required

Types of data quality checks.

check_intervalstring required

How often to run the check (cron expression or human-readable)

enabledboolean

Whether the schedule should be active immediately

check_configobject required

Configuration specific to the check type

metadataobject nullable

Additional metadata for the schedule

Example request

{
  "check_config": {
    "freshness_column": "created_at",
    "threshold_hours": 24
  },
  "check_interval": "daily",
  "check_type": "freshness",
  "enabled": true,
  "metadata": {
    "description": "Monitor user activity freshness",
    "owner": "data-team"
  },
  "table_path": "public.user_events"
}

Response

Successful Response

successboolean required
dataunknown
messagestring nullable
errorstring nullable
metaobject nullable

Changes

No recorded changes to this operation across all 1 revision of this API.