Vai al contenuto principale
POST
/
v1
/
monitors
Crea Monitor
curl --request POST \
  --url https://api.olostep.com/v1/monitors \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "<string>",
  "frequency": "<string>",
  "email": "<string>",
  "webhook_url": "<string>",
  "phone_number": "<string>",
  "metadata": {},
  "output_schema": {}
}
'
{
  "id": "<string>",
  "object": "monitor",
  "status": "active",
  "fda_id": "<string>",
  "query": "<string>",
  "frequency": "<string>",
  "cron_expression": "<string>",
  "notification_target": "<string>",
  "metadata": {},
  "output_schema": {},
  "created": 123,
  "updated": 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.

Autorizzazioni

​
Authorization
string
header
obbligatorio

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

Corpo

application/json
​
query
string
obbligatorio

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

​
frequency
string
obbligatorio

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.

​
email
string

Email di notifica. Mutuamente esclusiva con webhook_url e phone_number.

​
webhook_url
string<uri>

URL del webhook di notifica (http/https). Mutuamente esclusiva con email e phone_number.

​
phone_number
string

Numero di telefono per notifiche in formato E.164 (ad esempio: '+14155552671'). Quando fornito, le notifiche vengono inviate via SMS. Mutuamente esclusiva con email e webhook_url.

Pattern: ^\+[1-9]\d{1,14}$
​
metadata
object
​
output_schema
object

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

Risposta

Monitor accettato e attivato.

​
id
string
​
object
string
Esempio:

"monitor"

​
status
string
Esempio:

"active"

​
fda_id
string
​
query
string
​
frequency
string

Istruzione di programmazione in linguaggio naturale. Interpretata dal pianificatore; predefinita a UTC se non viene fornito un fuso orario.

​
cron_expression
string
​
notification_channel
enum<string>
Opzioni disponibili:
email,
webhook,
sms
​
notification_target
string
​
metadata
object
​
output_schema
object
​
created
integer
​
updated
integer