Skip to main content
POST
Generate a monitor title

Authorizations

Authorization
string
header
required

Organization API key (sl_…).

Headers

x-tenant-id
string
required

The organization ID the request is scoped to.

Body

application/json

A title for the monitor itself.

target
string
required
Allowed value: "monitor"
data_source
enum<string>
required

The data the monitor reads.

Available options:
account_spend,
organization_spend,
warehouse,
account_usage_group,
organization_usage_group,
workload,
custom,
insights,
storage,
select_org_spend,
databricks_workload,
databricks_query,
bigquery_workload,
bigquery_query,
bigquery_projects,
bigquery_reservation,
bigquery_storage,
budget
schedule
enum<string>
required

How often the monitor runs.

Available options:
hourly,
daily,
weekly,
monthly,
cron
metric_title
string | null

The display name of the measure being reported on.

threshold
number | null

The threshold a condition trigger compares against. Ignored for any other alert_type.

filters
Filters · object[] | null

The filters the query applies, each as {field, operator, value}.

alert_type
string | null

The monitor's trigger type, such as condition, anomaly or digest.

custom_sql_query
string | null

The monitor's SQL. Read only when data_source is custom.

cron
string | null

The monitor's cron expression. Read only when data_source is custom.

query_class
string | null

The query class the section's query runs against.

Response

Successful Response

A generated title.

title
string
required
read-only

The title, at most 120 characters.