Skip to content
StartupBuilder
by startups.studio
by Startups.Studio
Code
Changelog
APIProductBuild and shipMonitor

Monitor routes: create, get, list

The Monitor Verbs create, get, list as api.sb routes, with inputs, result, refusals and an example.

Reference for Monitor, one group of Monitor routes.

Monitor.create

Creates a Monitor. Verb page.

Text
POST /{namespace}/monitors

Body, as JSON: the inputs. Emits Monitor.created.

Inputs

InputTypeRequiredDescription
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.

Returns

OutputTypeRequiredDescription
monitorMonitorrequiredThe Monitor.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl -X POST https://api.sb/leaseline.app/monitors \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"kind":"internal","target":"/health"}'
JSON
{
  "api": "https://api.sb/leaseline.app",
  "monitor": {
    "$id": "https://api.sb/leaseline.app/monitors/monitor_8Ed0ESvvRl",
    "$type": "Monitor",
    "kind": "internal",
    "target": "/health"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Monitor.create",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Monitor.get

Returns one Monitor by id. Verb page.

Text
GET /{namespace}/monitors/{id}

Path: id. Query: the other inputs. Reads only: it emits no Event.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Monitor.
atstringA time or Version name: the record as it stood then. Unset: as it stands now.

Returns

OutputTypeRequiredDescription
monitorMonitorrequiredThe Monitor.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl https://api.sb/leaseline.app/monitors/monitor_8Ed0ESvvRl \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Monitor",
  "$id": "https://api.sb/leaseline.app/monitors/monitor_8Ed0ESvvRl",
  "monitor": {
    "$id": "https://api.sb/leaseline.app/monitors/monitor_8Ed0ESvvRl",
    "$type": "Monitor",
    "kind": "internal",
    "target": "/health"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/monitors/monitor_8Ed0ESvvRl",
    "up": "https://api.sb/leaseline.app/monitors"
  },
  "actions": {
    "check": "https://api.sb/leaseline.app/monitors/monitor_8Ed0ESvvRl/check"
  }
}

Monitor.list

Returns Monitors, newest first, one page at a time. Verb page.

Text
GET /{namespace}/monitors

Query: the inputs. Reads only: it emits no Event.

Inputs

InputTypeRequiredDescription
limitintegerAt most this many records, up to 100. The default is 20.
afterstringThe cursor from the previous page.
wherestringA filter over the properties, such as paidAt = null and total.amount > 500.
sortstringProperties to sort by, comma-separated; a leading minus sorts descending.
totalbooleanTrue adds the match count as meta.total, exact up to 10,000 matches and estimated above.
facetsstringProperties to count by value, comma-separated, returned as meta.facets.
fieldsstringProperties to return on each record, comma-separated; $id and $type always return.
includestringRelated records to embed in place of their URLs, comma-separated.
depthintegerHow many levels of related records to embed. The default is 1.
qstringWords to match across the text properties, ranked by relevance.
matchstringRanks the search by words, or meaning; words is the default.

Returns

OutputTypeRequiredDescription
monitorslist of MonitorrequiredOne page of Monitors.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl "https://api.sb/leaseline.app/monitors?limit=20" \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Monitor",
  "monitors": [
    {
      "$id": "https://api.sb/leaseline.app/monitors/monitor_8Ed0ESvvRl",
      "$type": "Monitor",
      "kind": "internal",
      "target": "/health"
    }
  ],
  "meta": {
    "limit": 20,
    "after": "monitor_8Ed0ESvvRl"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/monitors?limit=20",
    "next": "https://api.sb/leaseline.app/monitors?after=monitor_8Ed0ESvvRl"
  }
}

Monitor

Previous

update

Next