Create a monitor

curl --request POST \
  --url https://api.select.dev/v2/monitors \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-tenant-id: <x-tenant-id>' \
  --data '
{
  "name": "<string>",
  "trigger_config": {
    "skip_if_empty": true,
    "type": "digest"
  },
  "message_config": {
    "sections": [
      {
        "section_type": "title",
        "enabled": true
      }
    ],
    "title": "<string>",
    "templated_values": {}
  },
  "notification_frequency_config": {
    "frequency_type": "on_trigger"
  },
  "destination_ids": [
    "<string>"
  ],
  "cron": "<string>",
  "display_in_feed": true,
  "team_id": "<string>",
  "budget_id": "<string>",
  "snowflake_account_id": "<string>",
  "partition_config": {
    "partition_columns": [
      {
        "title": "<string>"
      }
    ]
  }
}
'

import requests

url = "https://api.select.dev/v2/monitors"

payload = {
    "name": "<string>",
    "trigger_config": {
        "skip_if_empty": True,
        "type": "digest"
    },
    "message_config": {
        "sections": [
            {
                "section_type": "title",
                "enabled": True
            }
        ],
        "title": "<string>",
        "templated_values": {}
    },
    "notification_frequency_config": { "frequency_type": "on_trigger" },
    "destination_ids": ["<string>"],
    "cron": "<string>",
    "display_in_feed": True,
    "team_id": "<string>",
    "budget_id": "<string>",
    "snowflake_account_id": "<string>",
    "partition_config": { "partition_columns": [{ "title": "<string>" }] }
}
headers = {
    "x-tenant-id": "<x-tenant-id>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-tenant-id': '<x-tenant-id>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: '<string>',
    trigger_config: {skip_if_empty: true, type: 'digest'},
    message_config: {
      sections: [{section_type: 'title', enabled: true}],
      title: '<string>',
      templated_values: {}
    },
    notification_frequency_config: {frequency_type: 'on_trigger'},
    destination_ids: ['<string>'],
    cron: '<string>',
    display_in_feed: true,
    team_id: '<string>',
    budget_id: '<string>',
    snowflake_account_id: '<string>',
    partition_config: {partition_columns: [{title: '<string>'}]}
  })
};

fetch('https://api.select.dev/v2/monitors', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.select.dev/v2/monitors",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'trigger_config' => [
        'skip_if_empty' => true,
        'type' => 'digest'
    ],
    'message_config' => [
        'sections' => [
                [
                                'section_type' => 'title',
                                'enabled' => true
                ]
        ],
        'title' => '<string>',
        'templated_values' => [
                
        ]
    ],
    'notification_frequency_config' => [
        'frequency_type' => 'on_trigger'
    ],
    'destination_ids' => [
        '<string>'
    ],
    'cron' => '<string>',
    'display_in_feed' => true,
    'team_id' => '<string>',
    'budget_id' => '<string>',
    'snowflake_account_id' => '<string>',
    'partition_config' => [
        'partition_columns' => [
                [
                                'title' => '<string>'
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "x-tenant-id: <x-tenant-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.select.dev/v2/monitors"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"trigger_config\": {\n    \"skip_if_empty\": true,\n    \"type\": \"digest\"\n  },\n  \"message_config\": {\n    \"sections\": [\n      {\n        \"section_type\": \"title\",\n        \"enabled\": true\n      }\n    ],\n    \"title\": \"<string>\",\n    \"templated_values\": {}\n  },\n  \"notification_frequency_config\": {\n    \"frequency_type\": \"on_trigger\"\n  },\n  \"destination_ids\": [\n    \"<string>\"\n  ],\n  \"cron\": \"<string>\",\n  \"display_in_feed\": true,\n  \"team_id\": \"<string>\",\n  \"budget_id\": \"<string>\",\n  \"snowflake_account_id\": \"<string>\",\n  \"partition_config\": {\n    \"partition_columns\": [\n      {\n        \"title\": \"<string>\"\n      }\n    ]\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-tenant-id", "<x-tenant-id>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.select.dev/v2/monitors")
  .header("x-tenant-id", "<x-tenant-id>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"trigger_config\": {\n    \"skip_if_empty\": true,\n    \"type\": \"digest\"\n  },\n  \"message_config\": {\n    \"sections\": [\n      {\n        \"section_type\": \"title\",\n        \"enabled\": true\n      }\n    ],\n    \"title\": \"<string>\",\n    \"templated_values\": {}\n  },\n  \"notification_frequency_config\": {\n    \"frequency_type\": \"on_trigger\"\n  },\n  \"destination_ids\": [\n    \"<string>\"\n  ],\n  \"cron\": \"<string>\",\n  \"display_in_feed\": true,\n  \"team_id\": \"<string>\",\n  \"budget_id\": \"<string>\",\n  \"snowflake_account_id\": \"<string>\",\n  \"partition_config\": {\n    \"partition_columns\": [\n      {\n        \"title\": \"<string>\"\n      }\n    ]\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.select.dev/v2/monitors")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-tenant-id"] = '<x-tenant-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"trigger_config\": {\n    \"skip_if_empty\": true,\n    \"type\": \"digest\"\n  },\n  \"message_config\": {\n    \"sections\": [\n      {\n        \"section_type\": \"title\",\n        \"enabled\": true\n      }\n    ],\n    \"title\": \"<string>\",\n    \"templated_values\": {}\n  },\n  \"notification_frequency_config\": {\n    \"frequency_type\": \"on_trigger\"\n  },\n  \"destination_ids\": [\n    \"<string>\"\n  ],\n  \"cron\": \"<string>\",\n  \"display_in_feed\": true,\n  \"team_id\": \"<string>\",\n  \"budget_id\": \"<string>\",\n  \"snowflake_account_id\": \"<string>\",\n  \"partition_config\": {\n    \"partition_columns\": [\n      {\n        \"title\": \"<string>\"\n      }\n    ]\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "name": "<string>",
  "data_source": "account_spend",
  "state": "enabled",
  "schedule": "hourly",
  "display_in_feed": true,
  "type": "digest",
  "trigger_config": {
    "skip_if_empty": true,
    "type": "digest"
  },
  "message_config": {
    "sections": [
      {
        "section_type": "title",
        "enabled": true
      }
    ],
    "title": "<string>",
    "templated_values": {}
  },
  "notification_frequency_config": {
    "frequency_type": "on_trigger"
  },
  "destination_ids": [
    "<string>"
  ],
  "status": "new",
  "latest_run_status": "new",
  "create_time": "<string>",
  "update_time": "<string>",
  "etag": "<string>",
  "cron": "<string>",
  "team_id": "<string>",
  "budget_id": "<string>",
  "snowflake_account_id": "<string>",
  "partition_config": {
    "partition_columns": [
      {
        "title": "<string>"
      }
    ]
  },
  "last_run_status": "new",
  "latest_run_error_message": "<string>",
  "latest_notification_send_time": "<string>",
  "latest_run_trigger_status": "triggered",
  "last_run_finish_time": "<string>",
  "next_run_time": "<string>",
  "dismiss_time": "<string>",
  "dismissed_by": "<string>",
  "dismissed_partitions": [
    {
      "partition_value": {},
      "dismiss_time": "<string>",
      "dismissed_by": "<string>"
    }
  ],
  "created_by": "<string>",
  "updated_by": "<string>"
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "validation_failed",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "validation_failed",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "validation_failed",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "validation_failed",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "validation_failed",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "validation_failed",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "validation_failed",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "validation_failed",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "validation_failed",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "validation_failed",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "validation_failed",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

POST

monitors

Create a monitor

curl --request POST \
  --url https://api.select.dev/v2/monitors \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-tenant-id: <x-tenant-id>' \
  --data '
{
  "name": "<string>",
  "trigger_config": {
    "skip_if_empty": true,
    "type": "digest"
  },
  "message_config": {
    "sections": [
      {
        "section_type": "title",
        "enabled": true
      }
    ],
    "title": "<string>",
    "templated_values": {}
  },
  "notification_frequency_config": {
    "frequency_type": "on_trigger"
  },
  "destination_ids": [
    "<string>"
  ],
  "cron": "<string>",
  "display_in_feed": true,
  "team_id": "<string>",
  "budget_id": "<string>",
  "snowflake_account_id": "<string>",
  "partition_config": {
    "partition_columns": [
      {
        "title": "<string>"
      }
    ]
  }
}
'

import requests

url = "https://api.select.dev/v2/monitors"

payload = {
    "name": "<string>",
    "trigger_config": {
        "skip_if_empty": True,
        "type": "digest"
    },
    "message_config": {
        "sections": [
            {
                "section_type": "title",
                "enabled": True
            }
        ],
        "title": "<string>",
        "templated_values": {}
    },
    "notification_frequency_config": { "frequency_type": "on_trigger" },
    "destination_ids": ["<string>"],
    "cron": "<string>",
    "display_in_feed": True,
    "team_id": "<string>",
    "budget_id": "<string>",
    "snowflake_account_id": "<string>",
    "partition_config": { "partition_columns": [{ "title": "<string>" }] }
}
headers = {
    "x-tenant-id": "<x-tenant-id>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-tenant-id': '<x-tenant-id>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: '<string>',
    trigger_config: {skip_if_empty: true, type: 'digest'},
    message_config: {
      sections: [{section_type: 'title', enabled: true}],
      title: '<string>',
      templated_values: {}
    },
    notification_frequency_config: {frequency_type: 'on_trigger'},
    destination_ids: ['<string>'],
    cron: '<string>',
    display_in_feed: true,
    team_id: '<string>',
    budget_id: '<string>',
    snowflake_account_id: '<string>',
    partition_config: {partition_columns: [{title: '<string>'}]}
  })
};

fetch('https://api.select.dev/v2/monitors', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.select.dev/v2/monitors",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'trigger_config' => [
        'skip_if_empty' => true,
        'type' => 'digest'
    ],
    'message_config' => [
        'sections' => [
                [
                                'section_type' => 'title',
                                'enabled' => true
                ]
        ],
        'title' => '<string>',
        'templated_values' => [
                
        ]
    ],
    'notification_frequency_config' => [
        'frequency_type' => 'on_trigger'
    ],
    'destination_ids' => [
        '<string>'
    ],
    'cron' => '<string>',
    'display_in_feed' => true,
    'team_id' => '<string>',
    'budget_id' => '<string>',
    'snowflake_account_id' => '<string>',
    'partition_config' => [
        'partition_columns' => [
                [
                                'title' => '<string>'
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "x-tenant-id: <x-tenant-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.select.dev/v2/monitors"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"trigger_config\": {\n    \"skip_if_empty\": true,\n    \"type\": \"digest\"\n  },\n  \"message_config\": {\n    \"sections\": [\n      {\n        \"section_type\": \"title\",\n        \"enabled\": true\n      }\n    ],\n    \"title\": \"<string>\",\n    \"templated_values\": {}\n  },\n  \"notification_frequency_config\": {\n    \"frequency_type\": \"on_trigger\"\n  },\n  \"destination_ids\": [\n    \"<string>\"\n  ],\n  \"cron\": \"<string>\",\n  \"display_in_feed\": true,\n  \"team_id\": \"<string>\",\n  \"budget_id\": \"<string>\",\n  \"snowflake_account_id\": \"<string>\",\n  \"partition_config\": {\n    \"partition_columns\": [\n      {\n        \"title\": \"<string>\"\n      }\n    ]\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-tenant-id", "<x-tenant-id>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.select.dev/v2/monitors")
  .header("x-tenant-id", "<x-tenant-id>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"trigger_config\": {\n    \"skip_if_empty\": true,\n    \"type\": \"digest\"\n  },\n  \"message_config\": {\n    \"sections\": [\n      {\n        \"section_type\": \"title\",\n        \"enabled\": true\n      }\n    ],\n    \"title\": \"<string>\",\n    \"templated_values\": {}\n  },\n  \"notification_frequency_config\": {\n    \"frequency_type\": \"on_trigger\"\n  },\n  \"destination_ids\": [\n    \"<string>\"\n  ],\n  \"cron\": \"<string>\",\n  \"display_in_feed\": true,\n  \"team_id\": \"<string>\",\n  \"budget_id\": \"<string>\",\n  \"snowflake_account_id\": \"<string>\",\n  \"partition_config\": {\n    \"partition_columns\": [\n      {\n        \"title\": \"<string>\"\n      }\n    ]\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.select.dev/v2/monitors")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-tenant-id"] = '<x-tenant-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"trigger_config\": {\n    \"skip_if_empty\": true,\n    \"type\": \"digest\"\n  },\n  \"message_config\": {\n    \"sections\": [\n      {\n        \"section_type\": \"title\",\n        \"enabled\": true\n      }\n    ],\n    \"title\": \"<string>\",\n    \"templated_values\": {}\n  },\n  \"notification_frequency_config\": {\n    \"frequency_type\": \"on_trigger\"\n  },\n  \"destination_ids\": [\n    \"<string>\"\n  ],\n  \"cron\": \"<string>\",\n  \"display_in_feed\": true,\n  \"team_id\": \"<string>\",\n  \"budget_id\": \"<string>\",\n  \"snowflake_account_id\": \"<string>\",\n  \"partition_config\": {\n    \"partition_columns\": [\n      {\n        \"title\": \"<string>\"\n      }\n    ]\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "name": "<string>",
  "data_source": "account_spend",
  "state": "enabled",
  "schedule": "hourly",
  "display_in_feed": true,
  "type": "digest",
  "trigger_config": {
    "skip_if_empty": true,
    "type": "digest"
  },
  "message_config": {
    "sections": [
      {
        "section_type": "title",
        "enabled": true
      }
    ],
    "title": "<string>",
    "templated_values": {}
  },
  "notification_frequency_config": {
    "frequency_type": "on_trigger"
  },
  "destination_ids": [
    "<string>"
  ],
  "status": "new",
  "latest_run_status": "new",
  "create_time": "<string>",
  "update_time": "<string>",
  "etag": "<string>",
  "cron": "<string>",
  "team_id": "<string>",
  "budget_id": "<string>",
  "snowflake_account_id": "<string>",
  "partition_config": {
    "partition_columns": [
      {
        "title": "<string>"
      }
    ]
  },
  "last_run_status": "new",
  "latest_run_error_message": "<string>",
  "latest_notification_send_time": "<string>",
  "latest_run_trigger_status": "triggered",
  "last_run_finish_time": "<string>",
  "next_run_time": "<string>",
  "dismiss_time": "<string>",
  "dismissed_by": "<string>",
  "dismissed_partitions": [
    {
      "partition_value": {},
      "dismiss_time": "<string>",
      "dismissed_by": "<string>"
    }
  ],
  "created_by": "<string>",
  "updated_by": "<string>"
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "validation_failed",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "validation_failed",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "validation_failed",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "validation_failed",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "validation_failed",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "validation_failed",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "validation_failed",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "validation_failed",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "validation_failed",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "validation_failed",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "validation_failed",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

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 monitor to create, or the full replacement for an existing one.

The body carries every setting a read returns, except the ones the server maintains. Filters naming a usage group or usage group set by name are stored by reference, so a rename carries through, and a read returns them by their current names. One that was deleted reads as a template resolved through message_config.templated_values, and keeps failing the monitor's runs until it is removed. Sending back either form, names or templates, is equivalent. A paragraph with no body_template, and a chart or table with no title, gets generated ones, which a read returns.

name

string

required

The monitor's name, as it appears in the feed.

Minimum string length: 1

data_source

enum<string>

required

The data the monitor reads. custom runs the monitor's own SQL, and requires a custom_sql_results section carrying it in custom_sql_query, and a snowflake_account_id to run it against.

Available options:

account_spend,

organization_spend,

warehouse,

account_usage_group,

organization_usage_group,

workload,

custom,

insights,

storage,

select_org_spend,

databricks_workload,

databricks_query,

databricks_served_endpoint,

databricks_endpoint_request,

bigquery_workload,

bigquery_query,

bigquery_projects,

bigquery_reservation,

bigquery_storage,

budget

state

enum<string>

required

Whether the monitor runs. A disabled or snoozed monitor is not scheduled.

Available options:

enabled,

disabled,

snoozed

schedule

enum<string>

required

How often the monitor runs. cron reads cron for the schedule.

Available options:

hourly,

daily,

weekly,

monthly,

cron

trigger_config

DigestTrigger · object

required

What the monitor checks, and the condition that makes it fire.

DigestTrigger
ConditionTrigger
AnomalyProphetTrigger
AnomalyPercentileTrigger
BudgetThresholdTrigger

Show child attributes

message_config

MonitorMessageConfig · object

required

What the monitor's notification says when it fires.

Show child attributes

notification_frequency_config

MonitorNotificationFrequencyOnTrigger · object

required

How often a firing monitor is allowed to notify.

MonitorNotificationFrequencyOnTrigger
MonitorNotificationFrequencyOnStatusChange
MonitorNotificationFrequencyLimitInTimePeriod

Show child attributes

destination_ids

string[]

required

The alert destinations the monitor notifies when it fires, as listed by /v2/destinations. An empty list notifies no one: the monitor still runs, and its runs still appear in the feed while display_in_feed is true.

cron

string | null

The cron expression the monitor runs on, in UTC. Required when schedule is cron, which only a monitor whose data_source is custom may use; null otherwise.

display_in_feed

boolean

default:true

Whether the monitor's runs appear in the monitors feed.

team_id

string | null

The team that owns this monitor. Null leaves it to the organization, or to snowflake_account_id when that is set. Requires permission to write monitors for that team.

budget_id

string | null

The budget this monitor watches. Null on a monitor that watches something other than a budget.

snowflake_account_id

string | null

The Snowflake account a custom SQL monitor runs its SQL against, as listed by /v2/snowflake-accounts. Required when data_source is custom and null otherwise, since every other source reads the organization as a whole.

partition_config

PartitionConfig · object | null

Splits the monitor into an independent check per distinct value of these columns. Null checks the data as a whole.

Show child attributes

Response

Successful Response

A scheduled check over the organization's data, and what it reports.

A monitor runs its trigger_config on schedule; when the trigger fires it renders message_config and sends it, as often as notification_frequency_config allows. partition_config splits one monitor into an independent check per partition, each of which triggers and is dismissed on its own.

string

required

read-only

The unique identifier of the monitor.

name

string

required

The monitor's name, as it appears in the feed.

data_source

enum<string>

required

The data the monitor reads. custom runs the monitor's own SQL.

Available options:

account_spend,

organization_spend,

warehouse,

account_usage_group,

organization_usage_group,

workload,

custom,

insights,

storage,

select_org_spend,

databricks_workload,

databricks_query,

databricks_served_endpoint,

databricks_endpoint_request,

bigquery_workload,

bigquery_query,

bigquery_projects,

bigquery_reservation,

bigquery_storage,

budget

state

enum<string>

required

Whether the monitor runs. A disabled or snoozed monitor is not scheduled and has no next run.

Available options:

enabled,

disabled,

snoozed

schedule

enum<string>

required

How often the monitor runs. cron reads cron for the schedule.

Available options:

hourly,

daily,

weekly,

monthly,

cron

display_in_feed

boolean

required

Whether the monitor's runs appear in the monitors feed.

type

enum<string>

required

read-only

What kind of check the monitor runs. The same value as trigger_config.type, lifted out so it can be filtered and read without parsing the configuration.

Available options:

digest,

condition,

anomaly_prophet,

anomaly_percentile,

budget_threshold

trigger_config

DigestTrigger · object

required

What the monitor checks, and the condition that makes it fire.

DigestTrigger
ConditionTrigger
AnomalyProphetTrigger
AnomalyPercentileTrigger
BudgetThresholdTrigger

Show child attributes

message_config

MonitorMessageConfig · object

required

What the monitor's notification says when it fires.

Show child attributes

notification_frequency_config

MonitorNotificationFrequencyOnTrigger · object

required

How often a firing monitor is allowed to notify.

MonitorNotificationFrequencyOnTrigger
MonitorNotificationFrequencyOnStatusChange
MonitorNotificationFrequencyLimitInTimePeriod

Show child attributes

destination_ids

string[]

required

The alert destinations the monitor notifies when it fires, as listed by /v2/destinations, in ascending order.

status

enum<string>

required

read-only

What the monitor is doing now. disabled or snoozed when its state stops it running; otherwise how its most recent run ended, or new when it has not run yet.

Available options:

new,

success,

failure,

triggered,

skipped,

snoozed,

unknown,

disabled

latest_run_status

enum<string>

required

read-only

How the most recent run in the monitor's run history ended. This ignores state, so a disabled monitor still reports the run it last completed, which status would report as disabled. A monitor with no run history reports new while enabled and unknown otherwise.

Available options:

new,

success,

failure,

triggered,

skipped,

snoozed,

unknown

create_time

string

required

read-only

RFC 3339 UTC creation timestamp.

update_time

string

required

read-only

RFC 3339 UTC last-update timestamp.

etag

string

required

read-only

Opaque strong ETag.

cron

string | null

The cron expression the monitor runs on, in UTC. Set only when schedule is cron.

team_id

string | null

The team that owns this monitor. Null means no team owns it — it belongs to the organization, or, for a monitor running its own SQL, to one connection.

budget_id

string | null

The budget this monitor watches. Null on a monitor that watches something other than a budget.

snowflake_account_id

string | null

The Snowflake account this monitor reads, as listed by /v2/snowflake-accounts. Set on a monitor running its own SQL. Null on a monitor that reads the organization as a whole.

partition_config

PartitionConfig · object | null

Splits the monitor into an independent check per distinct value of these columns. Null checks the data as a whole.

Show child attributes

last_run_status

enum<string> | null

How the monitor's most recent finished run ended, as the monitor itself recorded it. Null on a monitor that has never finished a run.

Available options:

new,

success,

failure,

triggered,

skipped,

snoozed,

unknown

latest_run_error_message

string | null

Why the most recent run failed. Null when that run succeeded, or when the monitor has not run.

latest_notification_send_time

string | null

RFC 3339 UTC timestamp of the last run that actually sent a notification. Null if the monitor has never notified.

latest_run_trigger_status

enum<string> | null

Whether the most recent run's trigger fired. Null until the monitor has run.

Available options:

triggered,

not_triggered,

skipped,

snoozed,

unknown

last_run_finish_time

string | null

RFC 3339 UTC timestamp of when the most recent run finished. Null until the monitor has run.

next_run_time

string | null

RFC 3339 UTC timestamp of when the monitor's schedule next comes due. The run itself starts once the data for that period has finished loading, which can be later. Null while the monitor is disabled or snoozed.

dismiss_time

string | null

RFC 3339 UTC timestamp of when the monitor was dismissed from the feed. Null while it is not dismissed.

dismissed_by

string | null

Who dismissed the monitor from the feed.

dismissed_partitions

MonitorPartitionDismissal · object[] | null

The partitions dismissed from the feed individually. Null on a monitor with no partitions dismissed.

Show child attributes

created_by

string | null

Who created the monitor.

updated_by

string | null

Who last changed the monitor. Null if no one has since it was created.

Get Started

Endpoints

Create a monitor

Authorizations

Headers

Body

Response