Skip to main content
GET
/
api
/
v1
/
assets
/
{asset_id}
Get asset by ID
curl --request GET \
  --url http://localhost:8000/api/v1/assets/{asset_id}
{
  "id": "<string>",
  "name": "<string>",
  "asset_type": "<string>",
  "is_active": true,
  "created_at": "<string>",
  "description": "<string>",
  "connection_status": "<string>",
  "discovery_state": "<string>",
  "last_refresh_at": "<string>",
  "table_count": 123,
  "column_count": 123,
  "schema_count": 123,
  "catalog_count": 123,
  "updated_at": "<string>",
  "host": "<string>",
  "port": 123,
  "database_name": "<string>",
  "username": "<string>",
  "ssl_enabled": true,
  "default_catalog": "<string>",
  "http_path": "<string>",
  "extra_params": {},
  "schema_status": "<string>",
  "schema_message": "<string>",
  "schema_change_status": "<string>",
  "schema_change_message": "<string>",
  "schema_change_summary": "<string>",
  "freshness_status": "<string>",
  "freshness_message": "<string>",
  "freshness_summary": "<string>",
  "lineage_status": "<string>",
  "lineage_message": "<string>",
  "tags_status": "<string>",
  "tags_message": "<string>",
  "tags_counts": {},
  "intelligence_status": "<string>",
  "intelligence_message": "<string>",
  "data_quality_status": "<string>",
  "data_quality_message": "<string>",
  "query_access_level": "<string>",
  "tags_mode": "<string>",
  "intelligence_mode": "<string>",
  "auto_tag_enabled": false,
  "effective_access_level": "<string>",
  "features": {}
}

Documentation Index

Fetch the complete documentation index at: https://docs.anomalyarmor.ai/llms.txt

Use this file to discover all available pages before exploring further.

Get complete details for a single asset including columns, relationships, freshness status, and tags.

When to Use

  • Asset details: Get full metadata for a specific table
  • Column inspection: List all columns with types and descriptions
  • Freshness check: Verify data recency for a single asset
  • Integration sync: Pull asset metadata into external tools

SDK & CLI Examples

from anomalyarmor import Client

client = Client(api_key="aa_live_xxx")

# Get by qualified name
asset = client.assets.get("snowflake.prod.public.orders")

print(f"Table: {asset.name}")
print(f"Columns: {len(asset.columns)}")
print(f"Freshness: {asset.freshness_status}")

# Access column details
for col in asset.columns:
    print(f"  {col.name}: {col.data_type}")

# Get by UUID
asset = client.assets.get(id="550e8400-e29b-41d4-a716-446655440000")

Parameters

ParameterTypeDescription
asset_idstringAsset ID (UUID) or qualified name
include_columnsbooleanInclude column details (default: true)

Response

{
  "id": "ast_abc123",
  "qualified_name": "snowflake.prod.public.orders",
  "asset_type": "table",
  "source": "snowflake.prod",
  "schema": "public",
  "name": "orders",
  "description": "Customer order records including order details and fulfillment status",
  "freshness": {
    "status": "fresh",
    "last_updated": "2024-01-15T08:30:00Z",
    "sla_threshold": "2h",
    "checked_at": "2024-01-15T09:00:00Z"
  },
  "columns": [
    {
      "name": "order_id",
      "data_type": "integer",
      "nullable": false,
      "description": "Unique identifier for each order",
      "tags": []
    },
    {
      "name": "user_email",
      "data_type": "varchar(255)",
      "nullable": true,
      "description": "Customer email address",
      "tags": ["pii:email"]
    }
  ],
  "tags": ["production", "critical"],
  "created_at": "2024-01-01T00:00:00Z",
  "updated_at": "2024-01-15T08:30:00Z"
}

Response Fields

FieldDescription
idUnique asset identifier
qualified_nameFull path: source.schema.table
descriptionHuman-readable description (generated or manual)
freshness.statusfresh, stale, or unknown
freshness.last_updatedTimestamp of most recent data
freshness.sla_thresholdConfigured freshness SLA
columnsArray of column definitions
columns[].tagsClassification tags on this column
tagsAsset-level tags

Error Responses

StatusMeaning
401Invalid or missing API key
404Asset not found
429Rate limit exceeded

Headers

Authorization
string

Path Parameters

asset_id
string
required

Response

Successful Response

Schema for asset responses.

id
string
required

Public UUID of the asset

name
string
required

Display name

asset_type
string
required

Type: table, view, etc.

is_active
boolean
required

Whether monitoring is active

created_at
string | null
required
description
string | null
connection_status
string | null
discovery_state
string | null
last_refresh_at
string | null
table_count
integer | null
column_count
integer | null
schema_count
integer | null
catalog_count
integer | null
updated_at
string | null
host
string | null
port
integer | null
database_name
string | null
username
string | null
ssl_enabled
boolean | null
default_catalog
string | null
http_path
string | null
extra_params
Extra Params · object
schema_status
string | null
schema_message
string | null
schema_change_status
string | null
schema_change_message
string | null
schema_change_summary
string | null
freshness_status
string | null
freshness_message
string | null
freshness_summary
string | null
lineage_status
string | null
lineage_message
string | null
tags_status
string | null
tags_message
string | null
tags_counts
Tags Counts · object
intelligence_status
string | null
intelligence_message
string | null
data_quality_status
string | null
data_quality_message
string | null
query_access_level
string | null
tags_mode
string | null
intelligence_mode
string | null
auto_tag_enabled
boolean
default:false
effective_access_level
string | null
features
Features · object