public-api
public-freshness

Create Freshness Schedule

Create a freshness monitoring schedule.

SDK Usage:

client = Client()
schedule = client.freshness.create_schedule(
    asset_id="my-asset-uuid",
    table_path="public.orders",
    check_interval="1h",
    expected_interval_hours=24,
)
print(f"Created schedule: {schedule.id}")
post/api/v1/sdk/freshness/schedules

Request

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

Headers

Authorizationstring

Request body

asset_idstring required

Asset UUID or qualified name

table_pathstring required

Table path (e.g., schema.table_name)

check_intervalstring required

Check interval: '5m', '1h', '6h', '1d', '1w'

expected_interval_hoursnumber nullable

Hours until data is considered stale (required for explicit mode)

freshness_columnstring nullable

Column to check for freshness (auto-detected if not provided)

monitoring_modestring

'auto_learn' or 'explicit'

is_activeboolean

Whether to enable monitoring

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.