Skip to main content
POST
モニター一覧

承認

pubrio-api-key
string
header
必須

API で実行する操作内容と、その操作に付与された権限を識別するための一意の API トークンです。このトークンはダッシュボードの 設定 画面から発行できます。

ボディ

application/json
destination_types
string[]

配信先タイプで絞り込みます(例:['email', 'webhook'])。空配列の場合はすべて返します。

detection_modes
string[]

検出モードで絞り込みます(例:['company_first', 'signal_first'])。空配列の場合はすべて返します。

status
enum<string>

モニターステータスで絞り込みます。

利用可能なオプション:
draft,
active,
paused,
inactive
is_ascending_order
boolean
デフォルト:false

昇順でソート。デフォルトはfalse(降順)。

order_by
enum<string>

並び替えに使用するフィールド。指定可能な値:'name'、'last_trigger_at'、'last_modified'。省略した場合、一覧は created_at の降順で並びます。

利用可能なオプション:
name,
last_trigger_at,
last_modified
search_term
string | null

モニター名のみに対して照合される検索語(正規表現、大文字小文字を区別しません)。

per_page
integer
デフォルト:25

1ページあたりの結果数。デフォルトは25。

page
integer
デフォルト:1

ページネーション用のページ番号。デフォルトは1。

profile_id
integer

オプション。リクエストを送信するチームを表す識別子です。API キーにワークスペース情報が既に含まれているため、このパラメータは必須ではなくなりました。指定した場合、検索結果が特定のチーム(ワークスペース)に紐づけられ、データ取得およびクレジット利用状況の追跡が可能になります。詳しくは、チーム関連の「ユーザー詳細」エンドポイントを参照してください。

レスポンス

ページネーション付きのモニター一覧を含む成功レスポンスです。ウォッチリスト連動のモニターはこの一覧から除外されます。

data
object