Passer au contenu principal
GET
/
v1
/
monitors
/
{monitor_id}
Obtenir un Moniteur
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>"
}

Autorisations

​
Authorization
string
header
requis

En-tête d'authentification Bearer de la forme Bearer , où est ton jeton d'authentification.

Paramètres de chemin

​
monitor_id
string
requis
Pattern: ^monitor_

Paramètres de requête

​
include_total_count
enum<string>

Défini à false ou 0 pour omettre total_count.

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

Quand vrai, inclut mermaid_diagram pour le DAG du moniteur.

Options disponibles:
true,
1

Réponse

Moniteur récupéré.

​
id
string

Identifiant unique du moniteur (monitor_…).

​
object
string
Exemple:

"monitor"

​
query
string

Intention de surveillance en langage naturel.

​
tracked
object

Cibles résolues que le moniteur suit après la fin de la planification.

​
source_policy
object

Listes d'autorisation et de refus d'URL/domaine optionnelles appliquées pendant la planification et l'exécution.

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

Schéma JSON optionnel pour la sortie d'extraction structurée.

​
status
enum<string>

Surveille l'état du cycle de vie.

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

Présent lorsque status est failed.

​
last_run
object

Résumé du dernier instantané. Inclus dans GET /v1/monitors/{monitor_id}.

​
agent
object
​
metadata
object
​
created
integer

Horodatage Unix (secondes).

​
updated
integer

Horodatage Unix (secondes).

​
total_count
integer

Nombre total d'instantanés. Inclus dans GET /v1/monitors/{monitor_id} sauf si include_total_count=false.

​
mermaid_diagram
string

Diagramme de flux Mermaid du DAG du moniteur. Inclus lorsque include-diagram=true lors de la récupération.