Skip to main content
POST
Создание монитора

Авторизации

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

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

Тело

application/json
query
string
обязательно

Описание монитора на естественном языке (на любом языке), например «отслеживать компании, выходящие на рынок Японии, получать руководителей уровня C с их рабочим email и отправлять оповещения на [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 отслеживает именованный список аккаунтов и требует хотя бы одну компанию, домен или URL LinkedIn. Неизменяемо после создания — изменение этого параметра у существующего монитора возвращает 40021. Вместо этого создайте новый монитор.

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

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

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

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

Пример:
company_filters
object

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

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

Список UUID domain_search_id компаний для мониторинга. Используется в основном в режиме company_first для указания целевых компаний. В качестве альтернативы можно использовать domains или linkedin_urls — требуется только один из трёх вариантов.

domains
string[]

Список доменов компаний для мониторинга (например, ["openai.com", "google.com"]). Альтернатива companies — Pubrio сопоставляет их с соответствующими компаниями. Требуется только один из вариантов: companies, domains или linkedin_urls.

linkedin_urls
string<uri>[]

Список URL компаний в LinkedIn для мониторинга (например, ["https://linkedin.com/company/pubrio"]). Альтернатива companies — Pubrio сопоставляет их с соответствующими компаниями. Требуется только один из вариантов: companies, domains или linkedin_urls.

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

Частота срабатывания в минутах. Мин: 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. См. Setting up Webhooks для рекомендаций.

Требуемый диапазон: 1 <= x <= 100
notification_email
string<email>

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 для более быстрого однопроходного варианта.

Ответ

Успешный ответ с данными только что созданного монитора.

data
object