Vai al contenuto principale
GET
/
v1
/
monitors
/
{monitor_id}
Ottieni Monitor
curl --request GET \
  --url https://api.olostep.com/v1/monitors/{monitor_id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "object": "monitor",
  "query": "<string>",
  "tracked": {
    "type": "<string>",
    "urls": [
      "<string>"
    ],
    "web_query": "<string>"
  },
  "source_policy": {
    "include_urls": [
      "<string>"
    ],
    "exclude_urls": [
      "<string>"
    ],
    "include_domains": [
      "<string>"
    ],
    "exclude_domains": [
      "<string>"
    ]
  },
  "schedule": {
    "frequency": "<string>",
    "cron": "<string>",
    "timezone": "UTC",
    "next_run_at": "2023-11-07T05:31:56Z"
  },
  "notification": {
    "events": [],
    "channels": [
      {
        "target": "<string>",
        "events": []
      }
    ]
  },
  "webhook": {
    "url": "<string>"
  },
  "output_schema": {},
  "error_message": "<string>",
  "last_run": {
    "id": "<string>",
    "status": "completed",
    "change_detected": true,
    "ran_at": "2023-11-07T05:31:56Z"
  },
  "agent": {
    "id": "<string>"
  },
  "metadata": {},
  "created": 123,
  "updated": 123,
  "total_count": 123,
  "mermaid_diagram": "<string>"
}

Autorizzazioni

​
Authorization
string
header
obbligatorio

Intestazione di autenticazione Bearer del tipo Bearer , dove è il tuo token di autenticazione.

Parametri del percorso

​
monitor_id
string
obbligatorio
Pattern: ^monitor_

Parametri della query

​
include_total_count
enum<string>

Imposta su false o 0 per omettere total_count.

Opzioni disponibili:
true,
false,
0,
1
​
include-diagram
enum<string>

Quando è vero, include mermaid_diagram per il DAG del monitor.

Opzioni disponibili:
true,
1

Risposta

Monitor recuperato.

​
id
string

Identificatore unico del monitor (monitor_…).

​
object
string
Esempio:

"monitor"

​
query
string

Intento di monitoraggio in linguaggio naturale.

​
tracked
object

Target risolti che il monitor traccia dopo il completamento della pianificazione.

​
source_policy
object

Liste di permessi e negazioni opzionali di URL/domini applicate durante la pianificazione e l'esecuzione.

​
schedule
object
​
notification
object
​
webhook
object
​
output_schema
object

Schema JSON opzionale per l'output di estrazione strutturata.

​
status
enum<string>

Monitora lo stato del ciclo di vita.

Opzioni disponibili:
provisioning,
active,
paused,
failed,
deleted
​
error_message
string | null

Presente quando status è failed.

​
last_run
object

Riepilogo dell'istantanea più recente. Incluso su GET /v1/monitors/{monitor_id}.

​
agent
object
​
metadata
object
​
created
integer

Timestamp Unix (secondi).

​
updated
integer

Timestamp Unix (secondi).

​
total_count
integer

Conteggio totale delle istantanee. Incluso su GET /v1/monitors/{monitor_id} a meno che include_total_count=false.

​
mermaid_diagram
string

Diagramma di flusso Mermaid del monitor DAG. Incluso quando include-diagram=true su get.