List violations

List all violation snapshots with optional filtering and pagination.

GET /api/data-readiness/violations

List violations

cURL

curl --request GET \
  --url https://api.example.com/api/data-readiness/violations \
  --header 'Authorization: Bearer <token>'

200

{
  "violations": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "fqn": "<string>",
      "dimension": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "assessment_type": "<string>",
        "display_name": "Accuracy"
      },
      "service": "<string>",
      "asset_fqn": "<string>",
      "asset_version": "<string>",
      "severity": "<string>",
      "status": "<string>",
      "workflow_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "<string>",
      "display_name": "Missing Description",
      "database": "analytics",
      "schema": "public",
      "table": "customers",
      "column": "email",
      "details": {
        "actual": "null",
        "expected": "not_null"
      },
      "dq_rule_execution_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "resolved_by": "admin",
      "resolution_notes": "Added missing description to column"
    }
  ],
  "pagination": {
    "page": 123,
    "per_page": 123,
    "total": 123,
    "total_pages": 123,
    "has_next": true,
    "has_prev": true
  }
}

Authorizations

Authorization · string · header · required

JWT Bearer token authentication. Include the token in the Authorization header as: Authorization: Bearer <token>. The JWT must contain valid client_id, and project_id claims for tenant isolation and SDK routing.

Query Parameters

page · integer · default: 1

Page number (1-indexed)

Required range: x >= 1

per_page · integer · default: 20

Items per page

Required range: 1 <= x <= 100

asset_fqn · string | null

Filter by asset FQN (prefix match)

service · string | null

Filter by service name

database · string | null

Filter by database name

schema · string | null

Filter by schema name

table · string | null

Filter by table name

severity · enum<string> | null

Filter by severity Severity level of a violation.

Available options: low, medium, high

status · enum<string> | null

Filter by status Lifecycle status of a violation.

Available options: open, resolved, acknowledged, false_positive

assessment_type · enum<string> | null

Filter by assessment type (metadata or data_quality) Type of assessment a dimension belongs to.

Available options: metadata, data_quality

dimension_id · string<uuid> | null

Filter by dimension ID

definition_name · string | null

Filter by violation definition

workflow_run_id · string<uuid> | null

Filter by Prefect workflow run ID

sort_by · enum<string> · default: created_at

Sort field

Available options: created_at, updated_at, severity, status, asset_fqn, service, database_name, schema_name, table_name

sort_order · enum<string> · default: desc

Sort direction

Available options: asc, desc

Response

200

application/json

Successful Response

Response model for paginated violation list.

violations · ViolationResponse · object[] · required

List of violations

Show child attributes

pagination · PaginationMeta · object · required

Pagination metadata

Show child attributes