> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pubrio.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 更新监控

> 更新现有监控的配置和检测规则。



## OpenAPI

````yaml cn-openapi POST /monitors/update
openapi: 3.0.0
info:
  description: >-
    Pubrio API 提供市场扩张情报——实时捕捉企业进入新市场的信号，以及其底层的公司与人员数据。可搜索、查找并丰富账户与联系人信息，并订阅覆盖
    200+ 市场、带类型与日期的动向信号。
  version: 1.0.0
  title: Pubrio OpenAPI
  termsOfService: https://pubrio.com/zh-CN/terms-of-service
  contact:
    email: king.lai@pubrio.com
    name: King Lai
    url: https://pubrio.com/zh-CN/get-in-touch
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
servers:
  - url: https://api.pubrio.com
security:
  - pubrio_api_key: []
tags:
  - name: Profile
    description: 工作区配置信息和使用统计
  - name: Enrichment
    description: 通过详细的 B2B 数据丰富人员和公司记录
  - name: Lookalike
    description: 查找与指定公司相似的公司
  - name: Search
    description: 使用筛选条件搜索人员、公司、职位、新闻和广告
  - name: Lookup
    description: 查找特定人员、公司、职位、新闻、广告和技术的详细信息
  - name: LinkedIn
    description: 通过 LinkedIn 个人资料 URL 查找人员和公司数据
  - name: Redeem
    description: 兑换积分以解锁人员联系方式（单个和批量）
  - name: Channels
    description: 管理外展渠道模板（创建、更新、删除、列表）
  - name: Monitor
    description: 创建和管理数据监控，包括 Webhook、统计和处理
  - name: Filters
    description: 获取搜索参数的可用筛选值（技术、地点、垂直领域等）
  - name: API Keys
    description: 查看 API 密钥的请求日志和使用情况分析
  - name: Insights
    description: 公司的信号聚合洞察(招聘、新闻、广告)。
  - name: Export
    description: 批量数据导出(消耗积分)。
  - name: Expansion
    description: 公司市场扩张情报:信号、阶段、市场与导出。
externalDocs:
  description: Pubrio API 用于搜索、预览和增强联系人及账户信息。Pubrio 数据库提供丰富的 B2B 联系人和销售情报数据。
  url: https://docs.pubrio.com
paths:
  /monitors/update:
    post:
      tags:
        - Monitor
      summary: 更新监控
      description: 更新现有监控的配置和检测规则。
      operationId: monitors_update
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                monitor_id:
                  type: string
                  format: uuid
                  description: 要更新的监控唯一标识符。
                name:
                  type: string
                  description: 监控名称。
                description:
                  type: string
                  description: 监控描述。
                detection_mode:
                  type: string
                  description: >-
                    信号的侦测方式。`signal_first` 面向市场广泛扫描；`company_first`
                    跟踪指定的客户名单，且至少需要一个公司、域名或 LinkedIn URL。**创建后不可修改** ——
                    对已有监控修改该字段会返回 `40021`，请改为新建监控。
                  enum:
                    - company_first
                    - signal_first
                signal_types:
                  type: array
                  items:
                    type: string
                    enum:
                      - jobs
                      - news
                      - advertisements
                      - expansions
                      - cloud_footprints
                  description: 要监控的信号类型。
                signal_filters:
                  type: array
                  items:
                    type: object
                    required:
                      - signal_type
                    properties:
                      signal_type:
                        type: string
                        enum:
                          - jobs
                          - news
                          - advertisements
                          - expansions
                          - cloud_footprints
                        description: 该条目筛选的信号流。
                      filters:
                        type: object
                        description: >-
                          该信号流的筛选条件。`jobs`、`news` 与 `advertisements` 使用 [Job
                          Search](/cn/api-reference/endpoint/companies/job_search)、[News
                          Search](/cn/api-reference/endpoint/companies/news_search)
                          与 [Advertisement
                          Search](/cn/api-reference/endpoint/companies/advertisements_search)
                          的参数。`expansions` 使用 [Expansion
                          Search](/cn/api-reference/endpoint/expansions/market_lookup)
                          的词汇：`froms` /
                          `tos`、`window_days`、`stages`、`scopes`、`momentum`、`freshness`、`signal_types`、`signal_subtypes`、`signal_strengths`、`source_types`。slug
                          取值见 [Expansion
                          Reference](/cn/api-reference/endpoint/expansions/types)。
                  description: 监控所观察的每个信号流对应一条。
                  example:
                    - signal_type: jobs
                      filters:
                        locations:
                          - US
                    - signal_type: news
                      filters:
                        locations:
                          - US
                    - signal_type: advertisements
                      filters:
                        target_locations:
                          - US
                    - signal_type: expansions
                      filters:
                        tos:
                          - US
                        stages:
                          - expanding
                          - scaling
                        signal_types:
                          - HIRE
                          - EXEC
                        signal_strengths:
                          - high
                          - very_high
                company_filters:
                  type: object
                  description: >-
                    全局公司过滤器，作为第二层应用。接受与[Company
                    Search](/cn/api-reference/endpoint/companies/search)端点相同的参数
                    — locations、employees、technologies、verticals 等。
                  example:
                    locations:
                      - US
                    employees:
                      - - 501
                        - 1000
                      - - 1001
                        - 5000
                companies:
                  type: array
                  items:
                    type: string
                    format: uuid
                  description: >-
                    公司 domain_search_id UUID 列表。也可使用 `domains` 或 `linkedin_urls`
                    作为替代方式。
                domains:
                  type: array
                  items:
                    type: string
                  description: 公司域名列表。可作为 `companies` 的替代方式。
                linkedin_urls:
                  type: array
                  items:
                    type: string
                    format: uri
                  description: LinkedIn 公司主页 URL 列表。可作为 `companies` 的替代方式。
                is_company_enrichment:
                  type: boolean
                  description: 是否增强公司数据。
                is_people_enrichment:
                  type: boolean
                  description: 是否增强人员数据。
                people_enrichment_configs:
                  type: array
                  items:
                    type: object
                  description: >-
                    人员增强层数组。每层执行独立的人员搜索。包含
                    `max_people_to_return`（1-25）、`people_contact_types`（联系类型数组，参见
                    [Redeem](/cn/api-reference/endpoint/redeem/people)
                    端点：email-work、email-personal、phone）和 `filters`（与[People
                    Search](/cn/api-reference/endpoint/people/search)端点相同的参数）。详见人员搜索端点了解可用过滤器，Redeem
                    端点了解联系类型。
                  example:
                    - filters:
                        people_locations:
                          - US
                      max_people_to_return: 3
                      people_contact_types:
                        - email-work
                destination_type:
                  type: string
                  description: 投递目标类型。
                  enum:
                    - webhook
                    - email
                    - sequences
                destination_config:
                  type: object
                  description: >-
                    目标配置。Webhook：需要 `webhook_url`（字符串），可选 `headers`（对象）和
                    `body`（对象）。Email：接受 `email`（字符串）或 `emails`（字符串数组）。sequences
                    类型需要 `sequence_identifier`（字符串），并且
                    `is_people_search_enrolled` / `is_company_contact_enrolled`
                    至少有一个设为 true。
                  example:
                    webhook_url: https://your-webhook.com/endpoint
                    headers:
                      Authorization: Bearer token
                    body:
                      pipeline: my-webhook
                frequency_minute:
                  type: integer
                  description: 触发频率（分钟）。最小值：0，最大值：10080，默认值：0。
                  minimum: 0
                  maximum: 10080
                max_failure_trigger:
                  type: integer
                  description: 暂停前的最大连续失败次数。最小值：1，最大值：10，默认值：5。
                  minimum: 1
                  maximum: 10
                max_daily_trigger:
                  type: integer
                  description: 每日最大触发次数。最小值：0，最大值：86400，默认值：500。
                  minimum: 0
                  maximum: 86400
                max_records_per_trigger:
                  type: integer
                  description: >-
                    控制每次触发最多推送的记录数量。较低的值可减少每次推送的数据量，适用于结果集较大或下游系统有速率限制的场景。最小值：1，最大值：100，默认值：25。详情请参阅
                    [配置 Webhooks](/cn/developer-guides/setting-up-webhooks)。
                  minimum: 1
                  maximum: 100
                excluded_companies:
                  type: array
                  items:
                    type: string
                  description: >-
                    此监控永不投递、永不计费的公司（`domain_search_id`
                    UUID）。两种检测模式都在运行时生效，早于数据增强和计费；同时出现在 `companies`
                    和此列表中的公司，在列表内期间被排除。列表上限：100,000（`excluded_companies`、`excluded_domains`、`excluded_linkedin_urls`
                    解析后的合计）。
                  example:
                    - 550e8400-e29b-41d4-a716-446655440002
                excluded_domains:
                  type: array
                  items:
                    type: string
                  description: >-
                    要排除的公司域名（如 ["existing-client.com"]），解析为公司后并入
                    `excluded_companies`。
                  example:
                    - existing-client.com
                excluded_linkedin_urls:
                  type: array
                  items:
                    type: string
                  description: 要排除的 LinkedIn 公司 URL，解析为公司后并入 `excluded_companies`。
                  example:
                    - https://linkedin.com/company/existing-client
                companies_mode:
                  type: string
                  enum:
                    - replace
                    - add
                    - remove
                  description: >-
                    本次发送的 `companies` / `domains` / `linkedin_urls`
                    如何作用于已保存的关注列表：`replace`（默认）整体替换，`add` 追加发送的公司，`remove`
                    移除它们。未发送的列表不会被改动。
                  example: add
                excluded_companies_mode:
                  type: string
                  enum:
                    - replace
                    - add
                    - remove
                  description: >-
                    排除列表（`excluded_companies` / `excluded_domains` /
                    `excluded_linkedin_urls`）同理：`replace`（默认）、`add` 或 `remove`。
                  example: add
                record_unit:
                  type: string
                  enum:
                    - signal
                    - company
                  description: >-
                    一条投递记录的单位：`signal`（载荷为 `signals[]`，每个信号一条）或 `company`（载荷为
                    `companies[]`，每家公司一条，信号嵌套其中）。默认跟随
                    `detection_mode`：`signal_first` → `signal`，`company_first` →
                    `company`。各上限（`max_records_per_trigger`、`max_daily_records`）按此单位计数。
                  example: company
                company_dedupe_days:
                  type: integer
                  minimum: 0
                  description: >-
                    同一家公司在此天数内最多出现在一次投递中（跨该监控的所有信号类型）；窗口内已投递的公司会从后续投递中剔除，其窗口内的后续信号被跳过而非排队。`0`
                    = 关闭。默认：0。
                  example: 30
                is_newest_first:
                  type: boolean
                  description: >-
                    优先投递最新的匹配信号。遇到单次或每日上限时保留最新的记录，监控游标仍前进到本次获取的最新一行，较旧的行被跳过而非排队。默认
                    `false`（最旧优先，不跳过）。
                  example: true
                max_daily_records:
                  type: integer
                  minimum: 0
                  description: >-
                    按所有者时区的自然日计算的每日投递记录硬上限（`0` =
                    不限）。按监控的记录单位统计成功投递；单次触发最多投递剩余额度，之后监控等待到次日，游标不前进。默认：0。
                  example: 200
                notification_email:
                  type: string
                  format: email
                  description: 失败通知邮箱。
                max_retry_per_trigger:
                  type: integer
                  description: 每次触发的最大重试次数。最小值：0，最大值：3，默认值：1。
                  minimum: 0
                  maximum: 3
                retry_delay_second:
                  type: integer
                  description: 重试间隔（秒）。最小值：1，最大值：5，默认值：1。
                  minimum: 1
                  maximum: 5
                status:
                  type: string
                  enum:
                    - draft
                    - active
                    - paused
                    - inactive
                  description: 要设置的生命周期状态。变更状态会重置失败计数器。
              required:
                - monitor_id
      responses:
        '200':
          description: >-
            成功响应，包含更新后的监控。响应始终包含
            monitor_id、name、detection_mode、destination_type、status、masked_signature
            和 last_modified，以及本次更新涉及的其他列。
          content:
            application/json:
              schema:
                type: object
                properties:
                  metadata:
                    type: object
                    properties:
                      unresolved:
                        type: object
                        description: >-
                          本次请求中各列表里没有解析到公司的输入（未发送的列表为
                          `null`）。请修正或删除；监控已按解析成功的公司保存。
                        properties:
                          companies:
                            type: object
                            nullable: true
                            properties:
                              domains:
                                type: array
                                items:
                                  type: string
                              linkedin_urls:
                                type: array
                                items:
                                  type: string
                          excluded_companies:
                            type: object
                            nullable: true
                            properties:
                              domains:
                                type: array
                                items:
                                  type: string
                              linkedin_urls:
                                type: array
                                items:
                                  type: string
                  data:
                    type: object
                    properties:
                      monitor_id:
                        type: string
                        format: uuid
                        description: 监控的唯一标识符。
                      name:
                        type: string
                        description: 监控名称。
                      detection_mode:
                        type: string
                        description: 检测模式。
                      destination_type:
                        type: string
                        description: 投递目标类型。
                      status:
                        type: string
                        enum:
                          - draft
                          - active
                          - paused
                          - inactive
                        description: 监控的生命周期状态。
                      masked_signature:
                        type: string
                        description: 已遮罩的 webhook 签名。
                      last_modified:
                        type: string
                        format: date-time
                        description: 监控最后修改的时间戳。
                      company_count:
                        type: integer
                      excluded_company_count:
                        type: integer
                    description: >-
                      The updated monitor. Any other columns included in the
                      update are also returned.
              example:
                data:
                  monitor_id: b2c3d4e5-f6a7-8901-bcde-f12345678901
                  name: Updated Monitor Name
                  detection_mode: company_first
                  destination_type: webhook
                  status: active
                  masked_signature: 9••••••••••••••••f09
                  last_modified: '2026-04-05T21:00:00.000Z'
                  company_count: 1
                  excluded_company_count: 0
        '400':
          $ref: '#/components/responses/general_error'
        '429':
          $ref: '#/components/responses/rate_limit_error'
        '500':
          $ref: '#/components/responses/server_error'
components:
  responses:
    general_error:
      description: 请求错误。请求格式不正确或包含无效参数。请检查错误代码和消息以获取详细信息。
      content:
        application/json:
          schema:
            required:
              - code
              - message
              - details
            type: object
            properties:
              code:
                example: 40001
                type: integer
              message:
                example: 错误及代码会根据不同场景有所不同，详情请参阅文档。
                type: string
              details:
                type: object
    rate_limit_error:
      description: 超出速率限制。在给定时间段内发送了过多请求。请在速率限制窗口重置后重试。
      content:
        application/json:
          schema:
            required:
              - error
            type: object
            properties:
              error:
                example: 请求频率超出限制。请稍后再试。
                type: string
    server_error:
      description: 内部服务器错误。服务器发生意外错误。如果错误持续存在，请联系支持团队。
      content:
        application/json:
          schema:
            required:
              - error
            type: object
            properties:
              error:
                example: 服务器在处理请求时遇到了未预料的异常。
                type: string
  securitySchemes:
    pubrio_api_key:
      type: apiKey
      name: pubrio-api-key
      description: >-
        一个唯一的 API 令牌，用于标识您通过 API 执行的操作以及相应的权限和操作。您可以在
        [设置](https://dashboard.pubrio.com/#/settings/) 部分创建该令牌。
      in: header

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.