メインコンテンツへスキップ
POST
/
monitors
モニター一覧
curl --request POST \
  --url https://api.pubrio.com/monitors \
  --header 'Content-Type: application/json' \
  --header 'pubrio-api-key: <api-key>' \
  --data '
{
  "destination_type": [
    "<string>"
  ],
  "detection_mode": [
    "<string>"
  ],
  "is_active": true,
  "is_paused": true,
  "is_ascending_order": false,
  "order_by": "last_modified",
  "search_term": "<string>",
  "per_page": 25,
  "page": 1,
  "profile_id": 123
}
'
{
  "data": {
    "pagination": {
      "page": 1,
      "per_page": 25,
      "total_entries": 8,
      "total_pages": 1,
      "total_display_pages": 1,
      "is_timeout": false
    },
    "monitors": [
      {
        "monitor_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "name": "Company First Monitor",
        "description": null,
        "detection_mode": "company_first",
        "signal_types": [
          "jobs",
          "news",
          "advertisements"
        ],
        "signal_filters": [
          {
            "filters": {
              "locations": [
                "US"
              ]
            },
            "signal_type": "jobs"
          },
          {
            "filters": {
              "locations": [
                "US"
              ]
            },
            "signal_type": "news"
          },
          {
            "filters": {
              "target_locations": [
                "US"
              ]
            },
            "signal_type": "advertisements"
          }
        ],
        "company_filters": {
          "locations": [
            "US"
          ]
        },
        "companies": [
          "67c4696b-b7b0-46b5-b2af-9f434543661e"
        ],
        "is_company_enrichment": true,
        "is_people_enrichment": true,
        "people_enrichment_configs": [
          {
            "filters": {
              "people_locations": [
                "US"
              ]
            },
            "max_people_to_return": 3,
            "people_contact_types": [
              "email-work"
            ]
          }
        ],
        "destination_type": "webhook",
        "destination_config": {
          "webhook_url": "https://usewebhook.com/example",
          "headers": {
            "X-Custom-Auth": "your-token"
          },
          "body": {
            "source": "pubrio"
          }
        },
        "notification_email": "[email protected]",
        "max_retry_per_trigger": 1,
        "retry_delay_second": 1,
        "max_records_per_trigger": 25,
        "max_daily_trigger": 500,
        "frequency_minute": 0,
        "is_active": true,
        "is_paused": false,
        "max_failure_trigger": 5,
        "repeated_failure_count": 0,
        "last_trigger_at": "2026-04-05T22:29:36.349Z",
        "last_processed_at": "2026-04-05T18:28:05.715Z",
        "masked_signature": "9••••••••••••••••f09",
        "created_at": "2026-04-03T18:49:20.048Z",
        "last_modified": "2026-04-05T22:29:36.349Z",
        "user": {
          "user_id": "a1b2c3d4-0000-0000-0000-000000000000",
          "nickname": "Jane Smith",
          "email": "[email protected]"
        },
        "total_trigger_today": 4,
        "success_rate": "1.000"
      },
      "..."
    ]
  }
}

承認

pubrio-api-key
string
header
必須

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

ボディ

application/json
destination_type
string[]

配信先タイプでフィルタリング(例:['email', 'webhook'])。空の配列はすべてを返します。

detection_mode
string[]

検出モードでフィルタリング(例:['company_first', 'signal_first'])。空の配列はすべてを返します。

is_active
boolean

アクティブステータスでフィルタリング。

is_paused
boolean

一時停止ステータスでフィルタリング。

is_ascending_order
boolean
デフォルト:false

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

order_by
string
デフォルト:last_modified

ソート対象のフィールド(例:'last_modified'、'created_at'、'name')。

search_term
string | null

名前または説明でモニターをフィルタリングする検索語。

per_page
integer
デフォルト:25

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

page
integer
デフォルト:1

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

profile_id
integer

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

レスポンス

ページネーション付きのモニター一覧を含む成功レスポンスです。

data
object