public-api
public-badges

Create badge

Create a new report badge.

SDK Usage:

from anomalyarmor import Client

client = Client()
badge = client.badges.create(
    asset="postgresql.analytics",
    label="Data Quality",
    tag_filters=["financial_reporting"]
)
print(f"Badge URL: {badge.badge_url}")

CLI Usage:

aa badges create "Data Quality" --asset postgresql.analytics --tags "financial_reporting"
post/api/v1/sdk/badges

Request

  • Base URL: http://localhost:8000
  • URL: http://localhost:8000/api/v1/sdk/badges
  • Auth: none declared

Headers

Authorizationstring

Request body

asset_idstring required

Asset identifier (public UUID or qualified name)

labelstring

Badge label text

tag_filtersstring[]

Tag names to filter monitored objects

schema_drift_enabledboolean

Enable schema drift monitoring

freshness_enabledboolean

Enable freshness monitoring

include_upstreamboolean

Include upstream dependencies

Response

Successful Response

successboolean required
dataunknown
messagestring nullable
errorstring nullable
metaobject nullable

Changes

No recorded changes to this operation across all 1 revision of this API.