Skip to main content
POST
モニターの作成

承認

pubrio-api-key
string
header
必須

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

ボディ

application/json
query
string
必須

モニターの自然言語による説明(任意の言語)。例:「日本に進出する企業を監視し、C レベルの人物の勤務先メールを取得して、[email protected] にリアルタイムでアラートを送る」。同一リクエスト内で下記のフィールド(detection_mode、signal_types、signal_filters、people_enrichment_configs、destination_type/destination_config、frequency_minute)に解析されます。明示的に渡したフィールドは解析結果より優先されます。テキストがモニターのリクエストでない場合は 400 を返します。最大 2000 文字。

Maximum string length: 2000
name
string

モニターの名前。

description
string

モニターの説明。

status
enum<string>
デフォルト:active

モニターを作成する際のライフサイクル状態。既定は activedraft を使うと未完成のモニターを保存できます(必須は name のみ、検証は有効化時まで延期され、下書きは実行されません)。

利用可能なオプション:
draft,
active,
paused,
inactive
detection_mode
enum<string>

シグナルの検出方法。signal_first は市場全体を広くスキャンし、company_first は指定した企業リストを追跡します(企業・ドメイン・LinkedIn URL のいずれかが 1 件以上必要)。作成後は変更できません — 既存モニターで変更すると 40021 が返ります。新しいモニターを作成してください。

利用可能なオプション:
company_first,
signal_first
signal_types
enum<string>[]

監視対象のシグナルタイプ。

利用可能なオプション:
jobs,
news,
advertisements,
expansions
signal_filters
object[]

シグナルフィルターオブジェクトの配列。各オブジェクトは signal_type(jobs、news、advertisements、expansions のいずれか)と filters(シグナル固有のパラメータを含むオブジェクト)で構成されます。シグナルタイプごとの利用可能なフィルターパラメータについては、Job SearchNews SearchAdvertisement Search を参照してください。expansions の場合は、Expansion Search のフィルター語彙(froms / tosstagesmomentumfreshnessscopessignal_typessignal_strengthswindow_days)を使用します。

:
company_filters
object

グローバル企業フィルター(第2レイヤーとしてすべてのシグナルタイプに適用)。Company Searchエンドポイントと同じパラメータ(locations、employees、technologies、verticals など)を受け付けます。利用可能なフィルターの完全なリストについては Company Search を参照してください。

:
companies
string<uuid>[]

監視対象の企業 domain_search_id UUID のリスト。主に company_first モードでターゲット企業を指定するために使用されます。domains または linkedin_urls を代替として使用することもできます — いずれか1つのみ必要です。

domains
string[]

監視対象の企業ドメインリスト(例: ["openai.com", "google.com"])。companies の代替として使用できます — Pubrio が対応する企業を自動的に解決します。companiesdomainslinkedin_urls のいずれか1つを指定してください。

linkedin_urls
string<uri>[]

LinkedInの企業ページURLリスト(例: ["https://linkedin.com/company/pubrio"])。companies の代替として使用できます。いずれか1つを指定してください。

is_company_enrichment
boolean

結果の企業データをエンリッチメントするかどうか。

is_people_enrichment
boolean

結果の人物データをエンリッチメントするかどうか。

people_enrichment_configs
object[]

人物エンリッチメントレイヤーの配列。各レイヤーは独立した人物検索を実行します。max_people_to_return(1-25)、people_contact_types(配列 — Redeem エンドポイントの連絡先タイプ: email-work、email-personal、phone を参照)、filtersPeople Search エンドポイントと同じパラメータ)を含みます。利用可能なフィルターパラメータについては People Search を、連絡先タイプの詳細については Redeem を参照してください。

:
destination_type
enum<string>

配信先タイプ。

利用可能なオプション:
webhook,
email,
sequences
destination_config
object

配信先の設定。Webhookの場合:webhook_url(文字列)が必須、headers(オブジェクト)と body(オブジェクト)はオプション。メールの場合:email(文字列)または emails(文字列の配列)を指定できます。sequences タイプは sequence_identifier(文字列)に加えて、is_people_search_enrolled / is_company_contact_enrolled の少なくとも一方を true に設定する必要があります。

frequency_minute
integer
デフォルト:0

トリガー頻度(分単位)。最小:0、最大:10080、デフォルト:0。

必須範囲: 0 <= x <= 10080
max_failure_trigger
integer
デフォルト:5

モニター一時停止前の最大連続失敗数。最小:1、最大:10、デフォルト:5。

必須範囲: 1 <= x <= 10
max_daily_trigger
integer
デフォルト:500

1日あたりの最大トリガー数。最小:0、最大:86400、デフォルト:500。

必須範囲: 0 <= x <= 86400
max_records_per_trigger
integer
デフォルト:25

トリガーごとに配信される最大レコード数を制御します。値を低く設定すると1回あたりのペイロードサイズが削減され、大量の結果セットやレート制限のある統合に推奨されます。最小値:1、最大値:100、デフォルト:25。詳細については Webhook の設定 をご覧ください。

必須範囲: 1 <= x <= 100
notification_email
string<email>

モニター失敗通知用のメールアドレス。

max_retry_per_trigger
integer
デフォルト:1

トリガーあたりの最大リトライ回数。最小:0、最大:3、デフォルト:1。

必須範囲: 0 <= x <= 3
retry_delay_second
integer
デフォルト:1

リトライ間の遅延(秒単位)。最小:1、最大:5、デフォルト:1。

必須範囲: 1 <= x <= 5
deep
boolean

任意。query と併用する場合のみ有効。精度向上のためにリフレクション処理を実行(既定 true。解析のレイテンシは約 2 倍)。false にすると単一パスで高速に解析します。

レスポンス

新規作成されたモニターの詳細を含む成功レスポンスです。

data
object