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

创建监控时的生命周期状态。默认为 active。使用 draft 可保存尚未完成的监控:仅需 name,校验会推迟到启用时,草稿不会运行。

可用选项:
draft,
active,
paused,
inactive
detection_mode
enum<string>

信号的侦测方式。signal_first 面向市场广泛扫描;company_first 跟踪指定的客户名单,且至少需要一个公司、域名或 LinkedIn URL。创建后不可修改 —— 对已有监控修改该字段会返回 40021,请改为新建监控。

可用选项:
company_first,
signal_first
signal_types
enum<string>[]

要监控的信号类型。

可用选项:
jobs,
news,
advertisements,
expansions,
cloud_footprints
signal_filters
object[]

监控所观察的每个信号流对应一条。

示例:
company_filters
object

全局公司过滤器,作为第二层应用。接受与Company Search端点相同的参数 — locations、employees、technologies、verticals 等。

示例:
companies
string<uuid>[]

要监控的公司 domain_search_id UUID 列表。主要在 company_first 模式下用于指定目标公司。也可使用 domains 或 linkedin_urls 作为替代方式 — 三者填写其一即可。

domains
string[]

公司域名列表(如 ["openai.com", "google.com"])。可作为 companies 的替代方式 — Pubrio 会自动解析对应的公司。companies、domains、linkedin_urls 三者填写其一即可。

linkedin_urls
string<uri>[]

LinkedIn 公司主页 URL 列表(如 ["https://linkedin.com/company/pubrio"])。可作为 companies 的替代方式。三者填写其一即可。

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)和 filters(与People Search端点相同的参数)。详见人员搜索端点了解可用过滤器,Redeem 端点了解联系类型。

示例:
destination_type
enum<string>

投递目标类型。

可用选项:
webhook,
email,
sequences
destination_config
object

目标配置。Webhook:需要 webhook_url(字符串),可选 headers(对象)和 body(对象)。Email:接受 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

每日最大触发次数。最小值:0,最大值:86400,默认值:500。

必填范围: 0 <= x <= 86400
max_records_per_trigger
integer
默认值:25

控制每次触发最多推送的记录数量。较低的值可减少每次推送的数据量,适用于结果集较大或下游系统有速率限制的场景。最小值:1,最大值:100,默认值:25。详情请参阅 配置 Webhooks。

必填范围: 1 <= x <= 100
excluded_companies
string[]

此监控永不投递、永不计费的公司(domain_search_id UUID)。两种检测模式都在运行时生效,早于数据增强和计费;同时出现在 companies 和此列表中的公司,在列表内期间被排除。列表上限:100,000(excluded_companies、excluded_domains、excluded_linkedin_urls 解析后的合计)。

示例:
excluded_domains
string[]

要排除的公司域名(如 ["existing-client.com"]),解析为公司后并入 excluded_companies。

示例:
excluded_linkedin_urls
string[]

要排除的 LinkedIn 公司 URL,解析为公司后并入 excluded_companies。

示例:
record_unit
enum<string>

一条投递记录的单位:signal(载荷为 signals[],每个信号一条)或 company(载荷为 companies[],每家公司一条,信号嵌套其中)。默认跟随 detection_mode:signal_first → signal,company_first → company。各上限(max_records_per_trigger、max_daily_records)按此单位计数。

可用选项:
signal,
company
示例:

"company"

company_dedupe_days
integer

同一家公司在此天数内最多出现在一次投递中(跨该监控的所有信号类型);窗口内已投递的公司会从后续投递中剔除,其窗口内的后续信号被跳过而非排队。0 = 关闭。默认:0。

必填范围: x >= 0
示例:

30

is_newest_first
boolean

优先投递最新的匹配信号。遇到单次或每日上限时保留最新的记录,监控游标仍前进到本次获取的最新一行,较旧的行被跳过而非排队。默认 false(最旧优先,不跳过)。

示例:

true

max_daily_records
integer

按所有者时区的自然日计算的每日投递记录硬上限(0 = 不限)。按监控的记录单位统计成功投递;单次触发最多投递剩余额度,之后监控等待到次日,游标不前进。默认:0。

必填范围: x >= 0
示例:

200

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;解析延迟约翻倍)。设为 false 可获得更快的单次解析。

响应

成功响应,包含新创建的监控详情。

metadata
object
data
object
最后修改于 2026年8月28日