Saltar al contenido principal
GET
/
v1
/
monitors
/
{monitor_id}
Obtener 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>"
}

Autorizaciones

​
Authorization
string
header
requerido

Encabezado de autenticación Bearer de la forma Bearer , donde es tu token de autenticación.

Parámetros de ruta

​
monitor_id
string
requerido
Pattern: ^monitor_

Parámetros de consulta

​
include_total_count
enum<string>

Configura a false o 0 para omitir total_count.

Opciones disponibles:
true,
false,
0,
1
​
include-diagram
enum<string>

Cuando es verdadero, incluye mermaid_diagram para el DAG del monitor.

Opciones disponibles:
true,
1

Respuesta

Monitor recuperado.

​
id
string

Identificador único del monitor (monitor_…).

​
object
string
Ejemplo:

"monitor"

​
query
string

Intención de monitoreo en lenguaje natural.

​
tracked
object

Objetivos resueltos que el monitor rastrea después de que se completa la planificación.

​
source_policy
object

Listas de permitidos y denegados de URL/dominio opcionales aplicadas durante la planificación y ejecución.

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

Esquema JSON opcional para la salida de extracción estructurada.

​
status
enum<string>

Monitorea el estado del ciclo de vida.

Opciones disponibles:
provisioning,
active,
paused,
failed,
deleted
​
error_message
string | null

Presente cuando status es failed.

​
last_run
object

Resumen de la última instantánea. Incluido en GET /v1/monitors/{monitor_id}.

​
agent
object
​
metadata
object
​
created
integer

Marca de tiempo Unix (segundos).

​
updated
integer

Marca de tiempo Unix (segundos).

​
total_count
integer

Conteo total de instantáneas. Incluido en GET /v1/monitors/{monitor_id} a menos que include_total_count=false.

​
mermaid_diagram
string

Diagrama de flujo Mermaid del monitor DAG. Incluido cuando include-diagram=true en get.