Skip to content
StartupBuilderby Startups.Studio
Business
Changelog
ProductBuild and ship

Monitor

A Monitor is a scheduled check on something outside a Startup’s control, such as uptime, a Keyword’s rank or an AI answer, recording Events.

Properties

PropertyTypeRequiredDescription
kindstringrequiredinternal watches the Startup’s own routes and jobs; outside watches the world, such as a rival’s price.
targetstringrequiredWhat it checks: a route, a Domain, a Keyword, a prompt or a page.
everystringHow often it runs, such as 1m or 1d.
lastResultstringThe result of its latest check.

Object

JSON
{
  "$id": "https://api.sb/kilnbakery.com/monitors/monitor_1",
  "$type": "Monitor",
  "kind": "internal",
  "target": "/health",
  "every": "1m",
  "lastResult": "passing"
}

Relationships

  • A Monitor opens many Incidents: a failing internal Monitor opens an Incident, which names the Monitor that saw it first. opens, inverse monitor.

Verbs

  1. createCreates a Monitor.
    POST /{namespace}/monitorsdoMonitor.created
  2. getReturns one Monitor by id.
    GET /{namespace}/monitors/{id}readNo Event
  3. listReturns Monitors, newest first, one page at a time.
    GET /{namespace}/monitorsreadNo Event
  4. updateChanges the given properties of a Monitor.
    PATCH /{namespace}/monitors/{id}doMonitor.updated
  5. checkCheck runs a Monitor once now from several regions and records the result as an Event.
    POST /{namespace}/monitors/{monitor}/checkdoMonitor.checked

Permissions

Which Access level may call each Verb. One-way Verbs wait their delay window.

Operationowneradminmemberviewer
Monitor.createYesYesYesNo
Monitor.getYesYesYesYes
Monitor.listYesYesYesYes
Monitor.updateYesYesYesNo
Monitor.checkYesYesYesNo

Call it

Text
Check the latest monitor.

Example

A scheduling app runs an outside Monitor that asks three answer engines "best scheduling app for clinics" once a day. When the app drops out of an answer, the Monitor records an Event and the Marketing Lead sees it.

Mapping.update

Previous Page

Monitor.check

Next Page