Zum Hauptinhalt springen
GET
/
v1
/
monitors
/
{monitor_id}
Monitor abrufen
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>"
}

Autorisierungen

​
Authorization
string
header
erforderlich

Bearer-Authentifizierungsheader in der Form Bearer , wobei dein Authentifizierungstoken ist.

Pfadparameter

​
monitor_id
string
erforderlich
Pattern: ^monitor_

Abfrageparameter

​
include_total_count
enum<string>

Auf false oder 0 setzen, um total_count auszulassen.

Verfügbare Optionen:
true,
false,
0,
1
​
include-diagram
enum<string>

Wenn wahr, wird mermaid_diagram für den Monitor-DAG eingeschlossen.

Verfügbare Optionen:
true,
1

Antwort

Monitor abgerufen.

​
id
string

Eindeutiger Monitor-Identifikator (monitor_…).

​
object
string
Beispiel:

"monitor"

​
query
string

Überwachungsabsicht in natürlicher Sprache.

​
tracked
object

Aufgelöste Ziele, die der Monitor nach Abschluss der Planung verfolgt.

​
source_policy
object

Optionale URL-/Domain-Zulassungs- und Sperrlisten, die während der Planung und Ausführung angewendet werden.

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

Optionales JSON-Schema für strukturierten Extraktionsausgabe.

​
status
enum<string>

Überwache den Lebenszyklusstatus.

Verfügbare Optionen:
provisioning,
active,
paused,
failed,
deleted
​
error_message
string | null

Vorhanden, wenn status failed ist.

​
last_run
object

Neueste Snapshot-Zusammenfassung. Enthalten bei GET /v1/monitors/{monitor_id}.

​
agent
object
​
metadata
object
​
created
integer

Unix-Zeitstempel (Sekunden).

​
updated
integer

Unix-Zeitstempel (Sekunden).

​
total_count
integer

Gesamtanzahl der Snapshots. Enthalten bei GET /v1/monitors/{monitor_id}, es sei denn, include_total_count=false.

​
mermaid_diagram
string

Mermaid-Flussdiagramm des Monitor-DAG. Enthalten, wenn include-diagram=true bei Abruf.