Monitors

get monitor

The monitor's schedule, webhook, next run time, and the dataset and columns it fills.

get/monitors/{id}

Request

Base URL
https://api.riveterhq.com/v1
Auth
HTTP bearer
TypeScript
https://skmtc.dev/riveterhq/apis/riveter-api/docs/monitors/:id/get.ts
A function with typed inputs. Its response is checked against the schema.

idstring required

The monitor id (mon_...)

The monitor

idstring

Monitor id (mon_...)

namestring

enabledboolean

cadence'daily' | 'weekly' | 'monthly'

minuteinteger

hourinteger

day_of_weekinteger nullable

day_of_monthinteger nullable

timezonestring

webhook_urlstring uri nullable

alert_rule'each_run' | 'on_diff' | 'disabled'

output_format'current_only' | 'include_diffs'

next_run_atstring date-time nullable

schedule_summarystring

Human-readable schedule (e.g. "Daily at 9:00 UTC")

dataset_idstring

The dataset each run fills (ds_...)

dataset_namestring

The dataset's name

columnsstring[]

The output column names each run fills (every one when absent)

enrichment_idstring

The dataset's enrichment

created_atstring date-time