Skip to main content
POST
Обновление монитора

Авторизации

pubrio-api-key
string
header
обязательно

Уникальный токен API, представляющий действия, которые вы выполняете через API, и соответствующие права доступа и операции. Вы можете создать его в разделе Settings.

Тело

application/json
monitor_id
string<uuid>
обязательно

Уникальный идентификатор монитора для обновления.

name
string

Название монитора.

description
string

Описание монитора.

detection_mode
enum<string>

Как обнаруживаются сигналы. signal_first сканирует рынок в широком масштабе; company_first отслеживает именованный список аккаунтов и требует хотя бы одну компанию, домен или URL LinkedIn. Неизменяемо после создания — изменение этого параметра у существующего монитора возвращает 40021. Вместо этого создайте новый монитор.

Доступные опции:
company_first,
signal_first
signal_types
enum<string>[]

Типы отслеживаемых сигналов.

Доступные опции:
jobs,
news,
advertisements,
expansions,
cloud_footprints
signal_filters
object[]

По одной записи на каждый поток сигналов, который отслеживает монитор.

Пример:
company_filters
object

Глобальные фильтры компаний, применяемые как второй уровень для всех типов сигналов. Принимает те же параметры, что и эндпоинт Company Search — местоположения, число сотрудников, технологии, отрасли и другое.

Пример:
companies
string<uuid>[]

Список UUID domain_search_id компаний. Альтернатива: используйте domains или linkedin_urls.

domains
string[]

Список доменов компаний. Альтернатива companies.

linkedin_urls
string<uri>[]

Список URL компаний в LinkedIn. Альтернатива 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).

Пример:
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. См. Setting up Webhooks для рекомендаций.

Требуемый диапазон: 1 <= x <= 100
excluded_companies
string[]

Компании, которые этот монитор никогда не доставляет и не тарифицирует, в виде UUID domain_search_id. Применяется в обоих режимах обнаружения во время выполнения, до обогащения и списания; компания, присутствующая и в companies, и в этом списке, исключается, пока остаётся в списке. Максимальный размер: 100 000 (разрешённые id из excluded_companies, excluded_domains и excluded_linkedin_urls).

Пример:
excluded_domains
string[]

Домены компаний для исключения (например ["existing-client.com"]). Разрешаются в компании и объединяются с excluded_companies.

Пример:
excluded_linkedin_urls
string[]

URL компаний LinkedIn для исключения. Разрешаются в компании и объединяются с excluded_companies.

Пример:
companies_mode
enum<string>

Как отправленные companies / domains / linkedin_urls применяются к сохранённому списку наблюдения: replace (по умолчанию) заменяет весь список, add добавляет отправленные компании, remove удаляет их. Неотправленные списки не затрагиваются.

Доступные опции:
replace,
add,
remove
Пример:

"add"

excluded_companies_mode
enum<string>

То же для списка исключений (excluded_companies / excluded_domains / excluded_linkedin_urls): replace (по умолчанию), add или remove.

Доступные опции:
replace,
add,
remove
Пример:

"add"

record_unit
enum<string>

Что считается одной доставленной записью: signal (payload signals[], одна запись на сигнал) или company (payload 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>

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, а также любые другие столбцы, изменённые при обновлении.

metadata
object
data
object

Обновлённый монитор. Также возвращаются любые другие столбцы, включённые в обновление.

Последнее изменение 4 сентября 2026 г.