Validity API

The Validity API enables programmatic management of data validity rules. Use it to enforce data quality constraints, detect invalid records, and integrate validation into your pipelines.

Endpoints

Method	Endpoint	Description
GET	`/api/v1/sdk/validity/{asset_id}/summary`	Get validity summary for an asset
GET	`/api/v1/sdk/validity/{asset_id}`	List validity rules for an asset
GET	`/api/v1/sdk/validity/{asset_id}/{rule_id}`	Get validity rule details
POST	`/api/v1/sdk/validity/{asset_id}`	Create a new validity rule
PATCH	`/api/v1/sdk/validity/{asset_id}/{rule_id}`	Update a validity rule
DELETE	`/api/v1/sdk/validity/{asset_id}/{rule_id}`	Delete a validity rule
POST	`/api/v1/sdk/validity/{asset_id}/{rule_id}/check`	Trigger validity check
GET	`/api/v1/sdk/validity/{asset_id}/{rule_id}/results`	List check results

Rule Types

Type	Description	Configuration
`NOT_NULL`	Column must not contain null values	None
`UNIQUE`	Column values must be unique	None
`REGEX`	Values must match a regex pattern	`rule_config.pattern`
`RANGE`	Numeric values must be within range	`rule_config.min`, `rule_config.max`
`ENUM`	Values must be in allowed set	`rule_config.allowed_values`
`DATE_FORMAT`	Values must match date format	`rule_config.format`
`CUSTOM_SQL`	Custom SQL expression	`rule_config.sql_expression`

Get Validity Summary

GET /api/v1/sdk/validity/{asset_id}/summary

Returns aggregate validity statistics for an asset.

curl -H "Authorization: Bearer aa_live_xxx" \
  "https://api.anomalyarmor.ai/api/v1/sdk/validity/550e8400-e29b-41d4-a716-446655440000/summary"

Response

{
  "data": {
    "total_rules": 12,
    "passing": 10,
    "failing": 1,
    "error": 1
  }
}

List Validity Rules

GET /api/v1/sdk/validity/{asset_id}

Query Parameters

Parameter	Type	Default	Description
`rule_type`	string	-	Filter by type (e.g., `NOT_NULL`, `REGEX`)
`is_active`	boolean	-	Filter by active status
`limit`	integer	50	Max results (max: 100)
`offset`	integer	0	Results to skip

curl -H "Authorization: Bearer aa_live_xxx" \
  "https://api.anomalyarmor.ai/api/v1/sdk/validity/550e8400-e29b-41d4-a716-446655440000?rule_type=NOT_NULL"

Response

{
  "data": {
    "items": [
      {
        "id": 123,
        "uuid": "v_550e8400-e29b-41d4-a716-446655440001",
        "table_path": "snowflake.prod.warehouse.orders",
        "column_name": "customer_email",
        "rule_type": "NOT_NULL",
        "name": "Customer Email Required",
        "severity": "critical",
        "is_active": true,
        "check_interval": "daily",
        "created_at": "2024-12-01T10:00:00Z"
      }
    ]
  },
  "pagination": {
    "total": 12,
    "limit": 50,
    "offset": 0,
    "has_more": false
  }
}

Get Validity Rule Details

GET /api/v1/sdk/validity/{asset_id}/{rule_id}

curl -H "Authorization: Bearer aa_live_xxx" \
  "https://api.anomalyarmor.ai/api/v1/sdk/validity/550e8400-e29b-41d4-a716-446655440000/v_550e8400-e29b-41d4-a716-446655440001"

Response

{
  "data": {
    "id": 123,
    "uuid": "v_550e8400-e29b-41d4-a716-446655440001",
    "table_path": "snowflake.prod.warehouse.orders",
    "column_name": "customer_email",
    "rule_type": "NOT_NULL",
    "rule_config": null,
    "name": "Customer Email Required",
    "description": "Email address must not be null for valid orders",
    "severity": "critical",
    "is_active": true,
    "alert_threshold_percent": 1.0,
    "treat_null_as_valid": false,
    "check_interval": "daily"
  }
}

Create Validity Rule

POST /api/v1/sdk/validity/{asset_id}

Requires read-write or admin scope.

Request Body

Field	Type	Required	Description
`rule_type`	string	Yes	Rule type (see table above)
`table_path`	string	Yes	Full table path (catalog.schema.table)
`column_name`	string	For column rules	Column name
`rule_config`	object	For some types	Rule-specific configuration
`name`	string	No	Human-readable rule name
`description`	string	No	Rule description
`severity`	string	No	`info`, `warning`, `critical` (default: `warning`)
`error_message`	string	No	Custom error message
`alert_threshold_percent`	float	No	Alert when invalid % exceeds this
`treat_null_as_valid`	boolean	No	Whether nulls pass (default: `false`)
`check_interval`	string	No	`hourly`, `daily`, `weekly` (default: `daily`)

Examples

curl -X POST -H "Authorization: Bearer aa_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "rule_type": "NOT_NULL",
    "table_path": "snowflake.prod.warehouse.orders",
    "column_name": "customer_email",
    "name": "Customer Email Required",
    "severity": "critical"
  }' \
  "https://api.anomalyarmor.ai/api/v1/sdk/validity/550e8400-e29b-41d4-a716-446655440000"

Response

{
  "data": {
    "id": 124,
    "uuid": "v_550e8400-e29b-41d4-a716-446655440002",
    "table_path": "snowflake.prod.warehouse.orders",
    "column_name": "customer_email",
    "rule_type": "NOT_NULL",
    "name": "Customer Email Required",
    "severity": "critical",
    "is_active": true,
    "check_interval": "daily",
    "created_at": "2024-12-04T10:30:00Z"
  }
}

Update Validity Rule

PATCH /api/v1/sdk/validity/{asset_id}/{rule_id}

Requires read-write or admin scope.

Request Body

Field	Type	Description
`is_active`	boolean	Whether rule is active
`name`	string	Rule name
`description`	string	Rule description
`severity`	string	Severity level
`alert_threshold_percent`	float	Alert threshold
`treat_null_as_valid`	boolean	Null handling
`check_interval`	string	Check interval

curl -X PATCH -H "Authorization: Bearer aa_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{"severity": "critical", "alert_threshold_percent": 0.5}' \
  "https://api.anomalyarmor.ai/api/v1/sdk/validity/550e8400-e29b-41d4-a716-446655440000/v_550e8400-e29b-41d4-a716-446655440001"

Delete Validity Rule

DELETE /api/v1/sdk/validity/{asset_id}/{rule_id}

Requires read-write or admin scope.

curl -X DELETE -H "Authorization: Bearer aa_live_xxx" \
  "https://api.anomalyarmor.ai/api/v1/sdk/validity/550e8400-e29b-41d4-a716-446655440000/v_550e8400-e29b-41d4-a716-446655440001"

Trigger Validity Check

POST /api/v1/sdk/validity/{asset_id}/{rule_id}/check

Requires read-write or admin scope.

Request Body

Field	Type	Default	Description
`sample_limit`	integer	10	Max invalid samples to collect

curl -X POST -H "Authorization: Bearer aa_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{"sample_limit": 20}' \
  "https://api.anomalyarmor.ai/api/v1/sdk/validity/550e8400-e29b-41d4-a716-446655440000/v_550e8400-e29b-41d4-a716-446655440001/check"

Response

{
  "data": {
    "id": 456,
    "validity_rule_id": 123,
    "status": "fail",
    "total_rows": 10000,
    "invalid_count": 25,
    "invalid_percent": 0.25,
    "invalid_samples": {
      "samples": [
        {"row_id": 1001, "value": null},
        {"row_id": 1042, "value": null}
      ]
    },
    "execution_duration_ms": 1250,
    "checked_at": "2024-12-04T10:35:00Z"
  }
}

List Check Results

GET /api/v1/sdk/validity/{asset_id}/{rule_id}/results

Query Parameters

Parameter	Type	Default	Description
`limit`	integer	100	Max results
`offset`	integer	0	Results to skip

curl -H "Authorization: Bearer aa_live_xxx" \
  "https://api.anomalyarmor.ai/api/v1/sdk/validity/550e8400-e29b-41d4-a716-446655440000/v_550e8400-e29b-41d4-a716-446655440001/results?limit=30"

Response

{
  "data": {
    "items": [
      {
        "id": 456,
        "validity_rule_id": 123,
        "status": "fail",
        "total_rows": 10000,
        "invalid_count": 25,
        "invalid_percent": 0.25,
        "execution_duration_ms": 1250,
        "checked_at": "2024-12-04T10:35:00Z"
      },
      {
        "id": 455,
        "validity_rule_id": 123,
        "status": "pass",
        "total_rows": 9975,
        "invalid_count": 0,
        "invalid_percent": 0.0,
        "execution_duration_ms": 1100,
        "checked_at": "2024-12-03T10:35:00Z"
      }
    ]
  },
  "pagination": {
    "total": 60,
    "limit": 30,
    "offset": 0,
    "has_more": true
  }
}

Use Case: Validate Email Format

Ensure all customer emails match a valid format:

from anomalyarmor import Client

client = Client()
asset_id = "550e8400-e29b-41d4-a716-446655440000"

# Create email validation rule
rule = client.validity.create(
    asset_id,
    rule_type="REGEX",
    table_path="snowflake.prod.warehouse.customers",
    column_name="email",
    rule_config={"pattern": r"^[\w.-]+@[\w.-]+\.\w{2,}$"},
    name="Valid Email Format",
    description="Validates email addresses match standard format",
    severity="warning",
    alert_threshold_percent=1.0,  # Alert if > 1% invalid
)

# Run initial check
result = client.validity.check(asset_id, rule.uuid, sample_limit=20)

if result.status == "fail":
    print(f"Warning: {result.invalid_count} invalid emails found")
    print(f"Invalid rate: {result.invalid_percent:.2f}%")
    for sample in (result.invalid_samples or {}).get("samples", [])[:5]:
        print(f"  - {sample}")
else:
    print("All emails are valid!")

Error Responses

Rule Not Found (404)

{
  "error": {
    "code": "RULE_NOT_FOUND",
    "message": "Validity rule not found",
    "details": {"rule_id": "v_invalid-uuid"}
  }
}

Invalid Rule Configuration (400)

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid regex pattern in rule_config",
    "details": {"field": "rule_config.pattern", "error": "Invalid regex syntax"}
  }
}

Forbidden (403)

{
  "error": {
    "code": "FORBIDDEN",
    "message": "Insufficient permissions. Required scope: read-write",
    "details": {"current_scope": "read-only", "required_scope": "read-write"}
  }
}

API Overview

API Reference

API Guides

Python SDK

CLI

Integrations

AI Agents

Endpoints

Rule Types

Get Validity Summary

Response

List Validity Rules

Query Parameters

Response

Get Validity Rule Details

Response

Create Validity Rule

Request Body

Examples

Response

Update Validity Rule

Request Body

Delete Validity Rule

Trigger Validity Check

Request Body

Response

List Check Results

Query Parameters

Response

Use Case: Validate Email Format

Error Responses

Rule Not Found (404)

Invalid Rule Configuration (400)

Forbidden (403)

API Overview

API Reference

API Guides

Python SDK

CLI

Integrations

AI Agents

​Endpoints

​Rule Types

​Get Validity Summary

​Response

​List Validity Rules

​Query Parameters

​Response

​Get Validity Rule Details

​Response

​Create Validity Rule

​Request Body

​Examples

​Response

​Update Validity Rule

​Request Body

​Delete Validity Rule

​Trigger Validity Check

​Request Body

​Response

​List Check Results

​Query Parameters

​Response

​Use Case: Validate Email Format

​Error Responses

​Rule Not Found (404)

​Invalid Rule Configuration (400)

​Forbidden (403)

Endpoints

Rule Types

Get Validity Summary

Response

List Validity Rules

Query Parameters

Response

Get Validity Rule Details

Response

Create Validity Rule

Request Body

Examples

Response

Update Validity Rule

Request Body

Delete Validity Rule

Trigger Validity Check

Request Body

Response

List Check Results

Query Parameters

Response

Use Case: Validate Email Format

Error Responses

Rule Not Found (404)

Invalid Rule Configuration (400)

Forbidden (403)