Skip to main content
POST
Crear un monitor

Autorizaciones

pubrio-api-key
string
header
requerido

Un token de API único que representa las acciones que realizas a través de la API, junto con los permisos y operaciones correspondientes. Puedes crearlo en la sección Configuración.

Cuerpo

application/json
query
string
requerido

Una descripción en lenguaje natural del monitor (en cualquier idioma), por ejemplo: "monitorea empresas que se expanden a Japón, obtén personas de nivel directivo (C-level) con su correo de trabajo, y envíame alertas por correo a [email protected] en tiempo real". Se interpreta en los campos siguientes (detection_mode, signal_types, signal_filters, people_enrichment_configs, destination_type/destination_config, frequency_minute) dentro de la misma solicitud. Cualquier campo que también envíes explícitamente sobrescribe el valor interpretado. Si el texto no es una solicitud de monitor, la llamada devuelve 400. Limitado a 2000 caracteres.

Maximum string length: 2000
name
string

Nombre del monitor.

description
string

Descripción del monitor.

status
enum<string>
predeterminado:active

Estado del ciclo de vida con el que se creará el monitor. El valor predeterminado es active. Usa draft para guardar un monitor a medio construir: solo se requiere name, la validación se aplaza hasta que lo actives, y un borrador nunca se ejecuta.

Opciones disponibles:
draft,
active,
paused,
inactive
detection_mode
enum<string>

Cómo se detectan las señales. signal_first explora el mercado de forma amplia; company_first hace seguimiento de una lista de cuentas específica y requiere al menos una empresa, dominio o URL de LinkedIn. Inmutable después de la creación: cambiarlo en un monitor existente devuelve 40021. Crea un nuevo monitor en su lugar.

Opciones disponibles:
company_first,
signal_first
signal_types
enum<string>[]

Tipos de señales a monitorear.

Opciones disponibles:
jobs,
news,
advertisements,
expansions
signal_filters
object[]

Una entrada por cada flujo de señales que vigila el monitor.

Ejemplo:
company_filters
object

Filtros globales de empresa aplicados como una segunda capa en todos los tipos de señal. Acepta los mismos parámetros que el endpoint de Búsqueda de empresas: ubicaciones, empleados, tecnologías, verticales y más.

Ejemplo:
companies
string<uuid>[]

Lista de UUID domain_search_id de empresas a monitorear. Se usa principalmente en el modo company_first para especificar las empresas objetivo. También puedes usar domains o linkedin_urls como alternativas; solo se requiere uno de los tres.

domains
string[]

Lista de dominios de empresas a monitorear (por ejemplo, ["openai.com", "google.com"]). Alternativa a companies: Pubrio los resuelve a las empresas correspondientes. Solo se requiere uno de companies, domains o linkedin_urls.

linkedin_urls
string<uri>[]

Lista de URLs de LinkedIn de empresas a monitorear (por ejemplo, ["https://linkedin.com/company/pubrio"]). Alternativa a companies: Pubrio las resuelve a las empresas correspondientes. Solo se requiere uno de companies, domains o linkedin_urls.

is_company_enrichment
boolean

Indica si se deben enriquecer los datos de la empresa en los resultados.

is_people_enrichment
boolean

Indica si se deben enriquecer los datos de personas en los resultados.

people_enrichment_configs
object[]

Arreglo de capas de enriquecimiento de personas. Cada capa ejecuta una búsqueda de personas independiente. Contiene max_people_to_return (1-25), people_contact_types (arreglo; se refiere a los tipos de contacto de Canjear: email-work, email-personal, phone) y filters (los mismos parámetros que el endpoint de Búsqueda de personas).

Ejemplo:
destination_type
enum<string>

Tipo de destino de entrega.

Opciones disponibles:
webhook,
email,
sequences
destination_config
object

Configuración del destino. Para webhook: requiere webhook_url (string), y opcionalmente headers (object) y body (object). Para email: acepta email (string) o emails (arreglo de strings). Para sequences: requiere sequence_identifier (string) además de al menos uno de is_people_search_enrolled / is_company_contact_enrolled establecido en true.

Ejemplo:
frequency_minute
integer
predeterminado:0

Frecuencia de activación en minutos. Mín.: 0, Máx.: 10080, Predeterminado: 0.

Rango requerido: 0 <= x <= 10080
max_failure_trigger
integer
predeterminado:5

Número máximo de fallos consecutivos antes de pausar el monitor. Mín.: 1, Máx.: 10, Predeterminado: 5.

Rango requerido: 1 <= x <= 10
max_daily_trigger
integer
predeterminado:500

Número máximo de activaciones por día. Mín.: 0, Máx.: 86400, Predeterminado: 500.

Rango requerido: 0 <= x <= 86400
max_records_per_trigger
integer
predeterminado:25

Controla el número máximo de registros entregados por activación. Los valores más bajos reducen el tamaño de la carga útil por entrega, lo cual se recomienda para conjuntos de resultados grandes o integraciones con límites de tasa. Mín.: 1, Máx.: 100, Predeterminado: 25. Consulta Configuración de webhooks para más orientación.

Rango requerido: 1 <= x <= 100
notification_email
string<email>

Dirección de correo electrónico para las notificaciones de fallos del monitor.

max_retry_per_trigger
integer
predeterminado:1

Número máximo de reintentos por activación. Mín.: 0, Máx.: 3, Predeterminado: 1.

Rango requerido: 0 <= x <= 3
retry_delay_second
integer
predeterminado:1

Retraso entre reintentos en segundos. Mín.: 1, Máx.: 5, Predeterminado: 1.

Rango requerido: 1 <= x <= 5
deep
boolean

Opcional, solo se usa con query. Ejecuta la pasada de reflexión para una mayor precisión de interpretación (el valor predeterminado es true; aproximadamente duplica la latencia de interpretación). Establece false para una única pasada más rápida.

Respuesta

Respuesta correcta que contiene los detalles del monitor recién creado.

data
object