# AnomalyArmor Documentation

> AnomalyArmor is a data observability platform that detects schema changes, data freshness issues, and quality problems before they impact your business. Connect your databases, get alerted to issues, and understand your data with AI.

## Developer Resources

Direct links to AnomalyArmor developer artifacts at predictable URLs.

- [AnomalyArmor OpenAPI Spec](https://docs.anomalyarmor.ai/api/openapi.json): Machine-readable OpenAPI 3.1 specification for the AnomalyArmor REST API
- [AnomalyArmor API Overview](https://docs.anomalyarmor.ai/api/overview.md): Programmatic access to AnomalyArmor data observability features via the REST API, OpenAPI 3.1 spec, and SDKs
- [AnomalyArmor API Authentication](https://docs.anomalyarmor.ai/api/authentication.md): Authenticate to the AnomalyArmor REST API with API keys, or to the AnomalyArmor MCP server with OAuth 2.1
- [AnomalyArmor Webhooks](https://docs.anomalyarmor.ai/alerts/destinations/webhooks.md): Send AnomalyArmor alerts to any HTTP endpoint for custom integrations
- [AnomalyArmor MCP Server](https://docs.anomalyarmor.ai/integrations/mcp-server.md): Connect AI assistants to AnomalyArmor with Model Context Protocol; OAuth 2.1 authorization-server metadata at https://mcp.anomalyarmor.ai/.well-known/oauth-authorization-server
- [AnomalyArmor MCP OAuth Authorization Server Metadata](https://mcp.anomalyarmor.ai/.well-known/oauth-authorization-server): RFC 8414 OAuth 2.1 authorization server discovery for the AnomalyArmor MCP server
- [AnomalyArmor MCP OAuth Protected Resource Metadata](https://mcp.anomalyarmor.ai/.well-known/oauth-protected-resource): RFC 9728 protected resource metadata for the AnomalyArmor MCP server
- [Python SDK Reference](https://docs.anomalyarmor.ai/sdk/reference.md): Complete Python SDK method reference for AnomalyArmor
- [JavaScript SDK Reference](https://docs.anomalyarmor.ai/sdk/javascript-reference.md): Full API reference for @anomalyarmor/sdk

## Getting Started

Essential guides for new users to connect their first database and set up monitoring.

- [Introduction](https://docs.anomalyarmor.ai/introduction.md): AnomalyArmor - Data observability for modern data teams
- [How It Works](https://docs.anomalyarmor.ai/how-it-works.md): Understand the architecture and data flow behind AnomalyArmor's data observability platform
- [Connect First Database](https://docs.anomalyarmor.ai/quickstart/connect-first-database.md): Step 1 - Add a database connection to AnomalyArmor
- [Run First Discovery](https://docs.anomalyarmor.ai/quickstart/run-first-discovery.md): Step 2 - Discover tables and schemas in your database
- [Set Up First Alert](https://docs.anomalyarmor.ai/quickstart/set-up-first-alert.md): Step 3 - Get notified when data issues occur
- [Create First Metric](https://docs.anomalyarmor.ai/quickstart/create-first-metric.md): Track row counts with ML-powered anomaly detection

## Core Concepts

Fundamental concepts to understand how AnomalyArmor works.

- [Overview](https://docs.anomalyarmor.ai/concepts/overview.md): The building blocks of data observability
- [Assets](https://docs.anomalyarmor.ai/concepts/assets.md): Tables, views, and other data objects that AnomalyArmor monitors
- [Discovery](https://docs.anomalyarmor.ai/concepts/discovery.md): How AnomalyArmor finds and catalogs your data assets
- [Schema Changes](https://docs.anomalyarmor.ai/concepts/schema-changes.md): Detecting and tracking structural changes to your data assets
- [Freshness](https://docs.anomalyarmor.ai/concepts/freshness.md): Monitor when your data was last updated
- [Metrics](https://docs.anomalyarmor.ai/concepts/metrics.md): Track statistical properties of your data and detect anomalies
- [Alerts](https://docs.anomalyarmor.ai/concepts/alerts.md): How you get notified when issues occur
- [Badges](https://docs.anomalyarmor.ai/concepts/badges.md): Embedded status indicators for data quality visibility
- [Intelligence](https://docs.anomalyarmor.ai/concepts/intelligence.md): AI-powered analysis that connects your monitoring context into actionable answers
- [Tagging](https://docs.anomalyarmor.ai/concepts/tagging.md): Classifying and organizing your assets
- [Jobs](https://docs.anomalyarmor.ai/concepts/jobs.md): Monitor and track background operations on your data assets

## Data Sources

Supported databases and connection guides.

- [Overview](https://docs.anomalyarmor.ai/data-sources/overview.md): Connect AnomalyArmor to your databases and data platforms
- [Postgresql](https://docs.anomalyarmor.ai/data-sources/postgresql.md): Connect AnomalyArmor to PostgreSQL databases including RDS, Aurora, and Supabase
- [Mysql](https://docs.anomalyarmor.ai/data-sources/mysql.md): Connect AnomalyArmor to MySQL databases including RDS, Aurora MySQL, and PlanetScale
- [Snowflake](https://docs.anomalyarmor.ai/data-sources/snowflake.md): Connect AnomalyArmor to your Snowflake data warehouse
- [Bigquery](https://docs.anomalyarmor.ai/data-sources/bigquery.md): Connect AnomalyArmor to Google BigQuery for schema monitoring and change detection
- [Redshift](https://docs.anomalyarmor.ai/data-sources/redshift.md): Connect AnomalyArmor to Amazon Redshift data warehouses
- [Databricks](https://docs.anomalyarmor.ai/data-sources/databricks.md): Connect AnomalyArmor to Databricks Unity Catalog
- [Clickhouse](https://docs.anomalyarmor.ai/data-sources/clickhouse.md): Connect AnomalyArmor to ClickHouse databases
- [Sql Server](https://docs.anomalyarmor.ai/data-sources/sql-server.md): Connect AnomalyArmor to SQL Server databases including Azure SQL Database and on-premise instances

## Detect Schema Changes

Detect and track changes to your database schemas.

- [Overview](https://docs.anomalyarmor.ai/schema-monitoring/overview.md): Detect and track schema changes across your data assets
- [Asset Discovery](https://docs.anomalyarmor.ai/schema-monitoring/asset-discovery.md): Configure and run discovery to catalog your database assets
- [Schema Drift](https://docs.anomalyarmor.ai/schema-monitoring/schema-drift.md): Detect and track schema changes over time to prevent data pipeline failures

## Monitor Data Health

Monitor data health with freshness checks and quality metrics.

- [Overview](https://docs.anomalyarmor.ai/data-quality/overview.md): Monitor the health and reliability of your data assets
- [Freshness Monitoring](https://docs.anomalyarmor.ai/data-quality/freshness-monitoring.md): Set SLAs on data freshness and detect stale data before it impacts your business
- [Metrics](https://docs.anomalyarmor.ai/data-quality/metrics.md): Monitor null percentages, distinct counts, and other column-level statistics to detect data quality issues
- [Row Count Monitoring](https://docs.anomalyarmor.ai/data-quality/row-count-monitoring.md): Monitor row counts with ML-based anomaly detection or explicit thresholds
- [Custom Sql Monitoring](https://docs.anomalyarmor.ai/data-quality/custom-sql-monitoring.md): Monitor any business rule by writing SQL queries that return a numeric value, with configurable thresholds and alerts.
- [Report Badges](https://docs.anomalyarmor.ai/data-quality/report-badges.md): Embed data quality status indicators in Databricks, Looker, Notion, and other tools

## Coverage Tiers

- [Overview](https://docs.anomalyarmor.ai/coverage-tiers/overview.md): Understand your monitoring coverage level and what each tier catches
- [Guide](https://docs.anomalyarmor.ai/coverage-tiers/guide.md): Step-by-step guide for upgrading your monitoring coverage tier
- [Score](https://docs.anomalyarmor.ai/coverage-tiers/score.md): How your coverage score is calculated and how to improve it

## Get Notified

Configure notifications for data issues.

- [Overview](https://docs.anomalyarmor.ai/alerts/overview.md): Get notified when data issues occur through flexible alert routing
- [Alert Rules](https://docs.anomalyarmor.ai/alerts/alert-rules.md): Configure when and how to receive alerts
- [Slack](https://docs.anomalyarmor.ai/alerts/destinations/slack.md): Send AnomalyArmor alerts to Slack channels
- [Email](https://docs.anomalyarmor.ai/alerts/destinations/email.md): Send AnomalyArmor alerts to email addresses for team notifications
- [Webhooks](https://docs.anomalyarmor.ai/alerts/destinations/webhooks.md): Send AnomalyArmor alerts to any HTTP endpoint for custom integrations
- [Pagerduty](https://docs.anomalyarmor.ai/alerts/destinations/pagerduty.md): Send AnomalyArmor alerts to PagerDuty for incident management
- [Ms Teams](https://docs.anomalyarmor.ai/alerts/destinations/ms-teams.md): Send AnomalyArmor alerts to Microsoft Teams channels
- [Linear](https://docs.anomalyarmor.ai/alerts/destinations/linear.md): Create Linear issues automatically from AnomalyArmor alerts
- [Incident Io](https://docs.anomalyarmor.ai/alerts/destinations/incident-io.md): Send AnomalyArmor alerts to incident.io for incident management
- [Schedules](https://docs.anomalyarmor.ai/alerts/schedules.md): Control when alert rules are active with time-based schedules
- [Blackouts](https://docs.anomalyarmor.ai/alerts/blackouts.md): Suppress all alerts during planned maintenance or holidays
- [Best Practices](https://docs.anomalyarmor.ai/alerts/best-practices.md): Reduce alert fatigue and improve response times with effective alerting strategies

## Understand Your Data

AI-powered documentation and natural language search.

- [Overview](https://docs.anomalyarmor.ai/intelligence/overview.md): AI that connects schema drift, freshness, data quality, and lineage into actionable answers
- [Object Profiles](https://docs.anomalyarmor.ai/intelligence/object-profiles.md): AI-generated intelligence profiles for every table, powered by your monitoring context
- [Ask Questions](https://docs.anomalyarmor.ai/intelligence/ask-questions.md): Chat with an AI agent that has full context from your monitoring setup
- [Use Cases](https://docs.anomalyarmor.ai/intelligence/use-cases.md): How monitoring context flows into Intelligence to solve real problems

## Organize & Tag

Classify and organize data with tags for governance.

- [Overview](https://docs.anomalyarmor.ai/data-classification/overview.md): Tag and categorize your data assets for governance and compliance
- [Auto Classification](https://docs.anomalyarmor.ai/data-classification/auto-classification.md): Automatically detect PII and sensitive data in your columns
- [Custom Tags](https://docs.anomalyarmor.ai/data-classification/custom-tags.md): Create and apply your own labels to organize data assets
- [Compliance](https://docs.anomalyarmor.ai/data-classification/compliance.md): Use tagging for audits, GDPR, and data governance

## Guides

Practical guides for common use cases.

- [Overview](https://docs.anomalyarmor.ai/guides/overview.md): Practical guides for common AnomalyArmor use cases
- [Video Tutorials](https://docs.anomalyarmor.ai/guides/video-tutorials.md): Step-by-step video walkthroughs of AnomalyArmor features
- [For Data Engineers](https://docs.anomalyarmor.ai/getting-started/for-data-engineers.md): Schema drift detection, CI/CD integration, and automation for data engineers
- [For Analytics Engineers](https://docs.anomalyarmor.ai/getting-started/for-analytics-engineers.md): Data quality metrics, freshness SLAs, and stakeholder reporting for analytics engineers
- [For Platform Teams](https://docs.anomalyarmor.ai/getting-started/for-platform-teams.md): Multi-database monitoring, incident management, team administration, and API integration
- [Prevent Pipeline Failures](https://docs.anomalyarmor.ai/guides/prevent-pipeline-failures.md): Catch schema changes before they break your dbt models and ETL jobs
- [Oncall Data Alerting](https://docs.anomalyarmor.ai/guides/oncall-data-alerting.md): Set up production monitoring with proper escalation and on-call routing
- [Compliance Monitoring](https://docs.anomalyarmor.ai/guides/compliance-monitoring.md): Track data lineage and changes for audit and compliance requirements
- [Lineage Upload](https://docs.anomalyarmor.ai/guides/lineage-upload.md): Import data lineage from dbt manifests, dbt Cloud, or manual definitions

## Account & Settings

Manage your account, team, and billing.

- [Profile](https://docs.anomalyarmor.ai/account/profile.md): Update your name, email, and account preferences
- [Team Management](https://docs.anomalyarmor.ai/account/team-management.md): Invite teammates and manage roles and permissions
- [Overview](https://docs.anomalyarmor.ai/billing/overview.md): Understand pricing, manage subscriptions, and track usage
- [Plans](https://docs.anomalyarmor.ai/billing/plans.md): AnomalyArmor subscription tiers
- [Usage Limits](https://docs.anomalyarmor.ai/billing/usage-limits.md): Understanding how monitor usage is calculated
- [Faq](https://docs.anomalyarmor.ai/billing/faq.md): Common billing questions answered

## Security

Security practices and data handling.

- [Overview](https://docs.anomalyarmor.ai/security/overview.md): How AnomalyArmor protects your data with enterprise-grade security controls
- [Query Gateway](https://docs.anomalyarmor.ai/security/query-gateway.md): How AnomalyArmor enforces SQL access restrictions with an open-source security layer
- [Data Handling](https://docs.anomalyarmor.ai/security/data-handling.md): What data AnomalyArmor accesses and how we protect it
- [Data Retention](https://docs.anomalyarmor.ai/security/data-retention.md): How long AnomalyArmor keeps your metadata and how to request deletion

## Help

Troubleshooting and support resources.

- [Common Setup Mistakes](https://docs.anomalyarmor.ai/troubleshooting/common-setup-mistakes.md): Avoid these common configuration errors when setting up AnomalyArmor
- [Connection Issues](https://docs.anomalyarmor.ai/troubleshooting/connection-issues.md): Troubleshoot database connectivity problems
- [Faq](https://docs.anomalyarmor.ai/troubleshooting/faq.md): Frequently asked questions about AnomalyArmor
- [Contact](https://docs.anomalyarmor.ai/support/contact.md): Contact support and find answers
- [Glossary](https://docs.anomalyarmor.ai/glossary.md): Key terms and definitions for AnomalyArmor

## Downloads

Downloadable resources and scripts.

- [Overview](https://docs.anomalyarmor.ai/downloads/overview.md): Downloadable resources for setting up AnomalyArmor

## API Overview

REST API introduction and authentication.

- [Overview](https://docs.anomalyarmor.ai/api/overview.md): Programmatic access to AnomalyArmor data observability features via the REST API, OpenAPI 3.1 spec, and SDKs
- [Authentication](https://docs.anomalyarmor.ai/api/authentication.md): Authenticate to the AnomalyArmor REST API with API keys, or to the AnomalyArmor MCP server with OAuth 2.1

## API Reference

API endpoint documentation.

- [List Assets](https://docs.anomalyarmor.ai/api-reference/list-assets.md): Retrieve all data assets (tables, views) you have access to
- [Get Asset](https://docs.anomalyarmor.ai/api-reference/get-asset.md): Retrieve details for a specific data asset
- [Get Freshness](https://docs.anomalyarmor.ai/api-reference/get-freshness.md): Retrieve freshness status for an asset or data source
- [Get Schema Changes](https://docs.anomalyarmor.ai/api-reference/get-schema-changes.md): Retrieve recent schema changes detected for an asset
- [List Alerts](https://docs.anomalyarmor.ai/api-reference/list-alerts.md): List triggered alerts with filtering by status, type, and date range

## API Guides

Guides for working with specific API features.

- [Assets](https://docs.anomalyarmor.ai/api/assets.md): List and retrieve data assets
- [Freshness](https://docs.anomalyarmor.ai/api/freshness.md): Monitor and validate data freshness
- [Schema](https://docs.anomalyarmor.ai/api/schema.md): Monitor schema changes and detect drift
- [Lineage](https://docs.anomalyarmor.ai/api/lineage.md): Explore data asset relationships and dependencies
- [Alerts](https://docs.anomalyarmor.ai/api/alerts.md): Query alert history and status
- [Metrics](https://docs.anomalyarmor.ai/api/metrics.md): Monitor and track data quality metrics like row counts, null percentages, and more
- [Validity](https://docs.anomalyarmor.ai/api/validity.md): Define and enforce data validity rules like NOT NULL, UNIQUE, and custom patterns
- [Referential Checks](https://docs.anomalyarmor.ai/api/referential-checks.md): Verify foreign key relationships and detect orphaned records

## SDKs

- [Overview](https://docs.anomalyarmor.ai/sdk/overview.md): Get started with the AnomalyArmor SDKs (Python and TypeScript)
- [Reference](https://docs.anomalyarmor.ai/sdk/reference.md): Complete Python SDK method reference
- [Error Handling](https://docs.anomalyarmor.ai/sdk/error-handling.md): Handle exceptions and debug SDK issues
- [Javascript](https://docs.anomalyarmor.ai/sdk/javascript.md): Install and use @anomalyarmor/sdk for TypeScript and JavaScript
- [Javascript Reference](https://docs.anomalyarmor.ai/sdk/javascript-reference.md): Full API reference for @anomalyarmor/sdk

## CLI

Command-line interface for AnomalyArmor.

- [Overview](https://docs.anomalyarmor.ai/cli/overview.md): Install and use the armor CLI for scripting, automation, and CI/CD integration
- [Reference](https://docs.anomalyarmor.ai/cli/reference.md): Complete command reference for the armor CLI

## Integrations

Connect AnomalyArmor with your data stack.

- [Contracts](https://docs.anomalyarmor.ai/guides/contracts.md): Export and import AnomalyArmor monitoring config as portable ODCS YAML
- [Migrate From Dbt](https://docs.anomalyarmor.ai/guides/migrate-from-dbt.md): Translate a dbt project's schema.yml into ODCS YAML and apply it to AnomalyArmor
- [Migrate From Great Expectations](https://docs.anomalyarmor.ai/guides/migrate-from-great-expectations.md): Convert a Great Expectations project into an AnomalyArmor data contract
- [First Integration](https://docs.anomalyarmor.ai/integrations/first-integration.md): Step-by-step guide to your first programmatic integration with AnomalyArmor
- [Airflow](https://docs.anomalyarmor.ai/integrations/airflow.md): Use AnomalyArmor in Apache Airflow DAGs
- [Dbt](https://docs.anomalyarmor.ai/integrations/dbt.md): Add data quality gates to your dbt workflows
- [Github](https://docs.anomalyarmor.ai/integrations/github.md): Connect GitHub repositories for code ownership, change tracking, and incident context
- [Github Actions](https://docs.anomalyarmor.ai/integrations/github-actions.md): Run data quality checks in your CI/CD pipeline with GitHub Actions
- [Mcp Server](https://docs.anomalyarmor.ai/integrations/mcp-server.md): Connect AI assistants to AnomalyArmor with Model Context Protocol
- [Mcp Apps](https://docs.anomalyarmor.ai/integrations/mcp-apps.md): Interactive chart rendering for AnomalyArmor MCP tools inside Claude Desktop and Cursor
- [Claude Code](https://docs.anomalyarmor.ai/integrations/claude-code.md): Use AnomalyArmor with Claude Code for AI-powered data observability
- [Cursor](https://docs.anomalyarmor.ai/integrations/cursor.md): Use AnomalyArmor with Cursor IDE for AI-powered data observability

## AI Agents

Natural language commands for AI assistants.

- [Overview](https://docs.anomalyarmor.ai/ai-agents/overview.md): Manage data observability through natural language, in the browser or your IDE
- [Web Agent](https://docs.anomalyarmor.ai/ai-agents/web-agent.md): Chat with the AI agent directly inside AnomalyArmor
- [Status](https://docs.anomalyarmor.ai/ai-agents/skills/status.md): Check overall data health with /armor:status
- [Alerts](https://docs.anomalyarmor.ai/ai-agents/skills/alerts.md): Query and manage alerts with /armor:alerts
- [Ask](https://docs.anomalyarmor.ai/ai-agents/skills/ask.md): Natural language Q&A with /armor:ask
- [Analyze](https://docs.anomalyarmor.ai/ai-agents/skills/analyze.md): Trigger AI analysis with /armor:analyze
- [Connect](https://docs.anomalyarmor.ai/ai-agents/skills/connect.md): Connect data sources with /armor:connect
- [Monitor](https://docs.anomalyarmor.ai/ai-agents/skills/monitor.md): Set up freshness monitoring with /armor:monitor
- [Quality](https://docs.anomalyarmor.ai/ai-agents/skills/quality.md): Set up data quality checks with /armor:quality
- [Tags](https://docs.anomalyarmor.ai/ai-agents/skills/tags.md): Classify data with /armor:tags
- [Lineage](https://docs.anomalyarmor.ai/ai-agents/skills/lineage.md): Explore data dependencies with /armor:lineage
- [Investigate](https://docs.anomalyarmor.ai/ai-agents/skills/investigate.md): Root cause analysis with /armor:investigate
- [Profile](https://docs.anomalyarmor.ai/ai-agents/skills/profile.md): Analyze table statistics with /armor:profile
- [Coverage](https://docs.anomalyarmor.ai/ai-agents/skills/coverage.md): Find monitoring gaps with /armor:coverage
- [Recommend](https://docs.anomalyarmor.ai/ai-agents/skills/recommend.md): Get AI-driven monitoring recommendations with /armor:recommend
- [Test](https://docs.anomalyarmor.ai/ai-agents/skills/test.md): Preview monitoring configurations before enabling with /armor:test

## Product Updates

Changelog and release notes.

- [Changelog](https://docs.anomalyarmor.ai/releases/changelog.md): Product updates, new features, and improvements to AnomalyArmor