メインコンテンツへスキップ
GET
/
v1
/
monitors
/
{monitor_id}
モニター取得
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>"
}

承認

Authorization
string
header
必須

Bearer 形式のBearer認証ヘッダー。はあなたの認証トークンです。

パスパラメータ

monitor_id
string
必須
Pattern: ^monitor_

クエリパラメータ

include_total_count
enum<string>

total_count を省略するには false または 0 に設定します。

利用可能なオプション:
true,
false,
0,
1
include-diagram
enum<string>

true の場合、モニターDAGの mermaid_diagram を含みます。

利用可能なオプション:
true,
1

レスポンス

モニターが取得されました。

id
string

ユニークなモニター識別子(monitor_…)。

object
string
:

"monitor"

query
string

自然言語でのモニタリングの意図。

tracked
object

計画が完了した後にモニターが追跡する解決済みのターゲット。

source_policy
object

計画と実行中に適用されるオプションのURL/ドメイン許可および拒否リスト。

schedule
object
notification
object
webhook
object
output_schema
object

構造化抽出出力のためのオプションのJSONスキーマ。

status
enum<string>

ライフサイクルステータスを監視する。

利用可能なオプション:
provisioning,
active,
paused,
failed,
deleted
error_message
string | null

statusfailedのときに表示される。

last_run
object

最新のスナップショットの概要。GET /v1/monitors/{monitor_id}で含まれる。

agent
object
metadata
object
created
integer

Unixタイムスタンプ(秒)。

updated
integer

Unixタイムスタンプ(秒)。

total_count
integer

スナップショットの総数。include_total_count=falseでない限り、GET /v1/monitors/{monitor_id}で含まれる。

mermaid_diagram
string

モニターDAGのMermaidフローチャート。include-diagram=trueのときに取得で含まれる。