Monitor
Pauses a Monitor, or changes how often it runs or what counts as a change.
- Action class
- None
- Approval
- Runs on its own
- Emits
Monitor.updated- Price
- Free
It extends the hub’s record call Monitor.update, which every Monitor takes. It is one of the Verbs of SEO.
Inputs
| Name | Type | Meaning |
|---|---|---|
id | string | Required. The id of the Monitor. |
kind | string | internal watches the startup’s own routes and jobs; outside watches the world, such as a rival’s price. Optional. |
target | string | What it checks: a route, a Domain, a Keyword, a prompt or a page. Optional. |
every | string | How often it runs, such as 1m or 1d. Optional. |
The hub inherits this call on every Noun: it takes the Monitor’s own Properties, listed on the hub’s Monitor page.
Outputs
| Field | Type | What null means |
|---|---|---|
monitor | Monitor | Never null: the Monitor as the call leaves it. |
Effects
- Action class
None: no approval rule names it, so it runs within its seat’s Permissions and Limits
- Modes
try: Runs every check and returns the record as it would be; nothing is stored.send: Returns a pending Action at once;Monitor.updatedfires when it is done.do: Waits for the Action to finish and returns the record.
- Idempotency
Only with a key: the same
Idempotency-Keyand input return the first Action, and the same key with other input returns409.- Saved or shared
The Monitor is saved as the call leaves it, with the Action that changed it.
- Emits
Monitor.updatedwith{ monitor }- Performed by
Whichever seat calls it
- Price
Free on your own account: the platform charges nothing for the call.
On each Venue
It acts on your own records and reaches no Venue, so every account answers the same way.
What try does
Runs every check the call meets and returns the record as it would be; nothing is stored, sent or posted.
Refuses when
The hub sets no guard of its own on this call: it refuses only on the shared checks every write meets (a missing record, a Permission the seat lacks).
When it waits
Returns in one response; nothing waits.
Example
In send mode the call returns its pending Action at once, and Monitor.updated delivers the result.
Check my rank for the template term daily instead of weekly.{
"mode": "send",
"action": {
"$id": "https://api.sb/leaseline.app/actions/action_Sd3kQ9vT2w" ,
"operation": "Monitor.update",
"status": "pending",
"reason": "running"
}
}To retry, send the same Idempotency-Key: the retry returns the first answer for $0. A new key reads again.
Used by
None.