Vai al contenuto principale
POST
/
v1
/
monitors
/
{monitor_id}
Aggiorna Monitor
curl --request POST \
  --url https://api.olostep.com/v1/monitors/{monitor_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "metadata": {},
  "frequency": "<string>"
}
'
{
  "id": "<string>",
  "object": "monitor",
  "team_id": "<string>",
  "fda_id": "<string>",
  "query": "<string>",
  "frequency": "<string>",
  "cron_expression": "<string>",
  "notification_target": "<string>",
  "metadata": {},
  "output_schema": {},
  "error_message": "<string>",
  "created_at": 123,
  "updated_at": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.olostep.com/llms.txt

Use this file to discover all available pages before exploring further.

Semantica di unione: Gli aggiornamenti dei metadati seguono l’approccio di Stripe — le nuove chiavi vengono aggiunte, le chiavi esistenti vengono aggiornate e le chiavi impostate su stringa vuota "" vengono eliminate.

Autorizzazioni

​
Authorization
string
header
obbligatorio

Header di autenticazione Bearer della forma Bearer , dove è il tuo token di autenticazione.

Parametri del percorso

​
monitor_id
string
obbligatorio

Identificatore univoco del monitor. Deve iniziare con monitor_.

Pattern: ^monitor_

Corpo

application/json
​
metadata
object

Patch dei metadati. I valori di stringa vuoti eliminano le chiavi.

​
frequency
string

Istruzione di pianificazione in linguaggio naturale (ad esempio: 'ogni giorno alle 9am America/Los_Angeles'). Se non viene specificato un fuso orario, viene utilizzato UTC.

Risposta

Monitor aggiornato con successo.

​
id
string

Identificatore univoco del monitor.

​
object
string
Esempio:

"monitor"

​
team_id
string
​
status
enum<string>

Stato del ciclo di vita del monitor. Valori comuni: active (in esecuzione secondo il programma), paused (programma disabilitato tramite /pause, può essere ripreso tramite /resume), deleted (cancellato temporaneamente).

Opzioni disponibili:
active,
paused,
deleted
​
fda_id
string
​
query
string

Intento di monitoraggio in linguaggio naturale. Se la query include un URL, il monitor si concentrerà su quell'URL.

​
frequency
string

Istruzione di programmazione in linguaggio naturale (ad esempio: 'ogni giorno alle 9am America/Los_Angeles' o 'ogni giorno feriale alle 14:30'). Se non viene specificato un fuso orario, viene utilizzato UTC.

​
cron_expression
string | null
​
notification_channel
enum<string>
Opzioni disponibili:
email,
webhook,
sms
​
notification_target
string
​
metadata
object
​
output_schema
object

Schema JSON opzionale utilizzato per imporre un'uscita strutturata dell'estrazione del monitor.

​
error_message
string | null
​
created_at
integer

Timestamp Unix.

​
updated_at
integer

Timestamp Unix.