Skip to main content
POST
更新监控

授权

pubrio-api-key
string
header
必填

一个唯一的 API 令牌,用于标识您通过 API 执行的操作以及相应的权限和操作。您可以在 设置 部分创建该令牌。

请求体

application/json
monitor_id
string<uuid>
必填

要更新的监控唯一标识符。

name
string

监控名称。

description
string

监控描述。

detection_mode
enum<string>

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

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

示例:
companies
string<uuid>[]

公司 domain_search_id UUID 列表。也可使用 domainslinkedin_urls 作为替代方式。

domains
string[]

公司域名列表。可作为 companies 的替代方式。

linkedin_urls
string<uri>[]

LinkedIn 公司主页 URL 列表。可作为 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,最大值:10080,默认值:0。

必填范围: 0 <= x <= 10080
max_failure_trigger
integer

暂停前的最大连续失败次数。最小值:1,最大值:10,默认值:5。

必填范围: 1 <= x <= 10
max_daily_trigger
integer

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

必填范围: 0 <= x <= 86400
max_records_per_trigger
integer

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

必填范围: 1 <= x <= 100
notification_email
string<email>

失败通知邮箱。

max_retry_per_trigger
integer

每次触发的最大重试次数。最小值:0,最大值:3,默认值:1。

必填范围: 0 <= x <= 3
retry_delay_second
integer

重试间隔(秒)。最小值:1,最大值:5,默认值:1。

必填范围: 1 <= x <= 5
status
enum<string>

要设置的生命周期状态。变更状态会重置失败计数器。

可用选项:
draft,
active,
paused,
inactive

响应

成功响应,包含更新后的监控。响应始终包含 monitor_id、name、detection_mode、destination_type、status、masked_signature 和 last_modified,以及本次更新涉及的其他列。

data
object

The updated monitor. Any other columns included in the update are also returned.