Schema Drift Detection

Run Schema Drift Detection

POST /v1/data-catalog/schema-drift-detection

Run schema drift detection to identify changes in data structure for entities from a specific integration.

Request Body:

Required fields:

• integrationId
• organizationId

{
  "integrationId": "i1b2c3d4-e5f6-7890-1234-567890abcdef",
  "organizationId": "a1b2c3d4-e5f6-7890-1234-567890abcdef"
}

Response (204 No Content):

The operation completes successfully with no response body. Schema drift detection is initiated and will run asynchronously in the background.

Error Responses:

Response (400 Bad Request):

{
  "code": "INVALID_REQUEST",
  "title": "Invalid Request",
  "detail": "Both integrationId and organizationId are required and must be valid UUIDs",
  "traceId": "req_12345678-abcd-4321-9876-fedcba098765"
}

Response (404 Not Found):

{
  "code": "INTEGRATION_NOT_FOUND",
  "title": "Integration Not Found",
  "detail": "No integration found with the specified ID for the given organization",
  "traceId": "req_12345678-abcd-4321-9876-fedcba098765"
}

Response (500 Internal Server Error):

{
  "code": "DRIFT_DETECTION_FAILED",
  "title": "Schema Drift Detection Failed",
  "detail": "Failed to initiate schema drift detection process",
  "traceId": "req_12345678-abcd-4321-9876-fedcba098765"
}

Schema Drift Detection Overview

Schema drift detection is a background process that:

1. Analyzes Current Schema: Examines the current structure of entities and fields for a given integration
2. Compares with Historical Data: Identifies differences from previously cataloged schema information
3. Detects Changes: Identifies added, removed, or modified fields and entities
4. Updates Catalog: Refreshes the data catalog with detected schema changes
5. Maintains Data Lineage: Preserves relationships and historical information during updates

This process helps maintain data catalog accuracy as source systems evolve over time.