public-api
public-freshness

Freshness Dry Run

Dry-run a freshness threshold against historical data.

Tests a proposed freshness threshold against a table's actual update history to predict how many alerts would fire. This helps users tune thresholds before enabling monitoring.

SDK Usage:

from anomalyarmor import Client
client = Client()

result = client.freshness.dry_run(
    asset_id="my-asset-uuid",
    table_path="public.orders",
    expected_interval_hours=2.0,
    lookback_days=7,
)

print(f"Alert rate: {result.alert_rate_percent}%")
print(f"Recommendation: {result.recommendation}")
post/api/v1/sdk/freshness/dry-run

Request

  • Base URL: http://localhost:8000
  • URL: http://localhost:8000/api/v1/sdk/freshness/dry-run
  • Auth: none declared

Headers

Authorizationstring

Request body

asset_idstring required

Asset UUID or qualified name

table_pathstring required

Table to test (e.g., 'schema.table')

expected_interval_hoursnumber required

Threshold in hours to test

lookback_daysinteger

Days of history to analyze

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.