Skip to main content
POST
Criar um monitor

Autorizações

pubrio-api-key
string
header
obrigatório

Um token de API exclusivo que representa as ações que você realiza por meio da API e as permissões e operações correspondentes. Você pode criá-lo na seção Configurações.

Corpo

application/json
query
string
obrigatório

Uma descrição em linguagem natural do monitor (em qualquer idioma), por exemplo "monitor companies expanding into Japan, get C-level people with their work email, and email alerts to [email protected] in real time". É interpretada nos campos abaixo (detection_mode, signal_types, signal_filters, people_enrichment_configs, destination_type/destination_config, frequency_minute) na mesma requisição. Qualquer campo também passado explicitamente substitui o valor interpretado. Se o texto não for um pedido de monitor, a chamada retorna 400. Limitado a 2000 caracteres.

Maximum string length: 2000
name
string

Nome do monitor.

description
string

Descrição do monitor.

status
enum<string>
padrão:active

Status do ciclo de vida com o qual criar o monitor. O padrão é active. Use draft para salvar um monitor incompleto: apenas name é obrigatório, a validação é adiada até a ativação, e um rascunho nunca é executado.

Opções disponíveis:
draft,
active,
paused,
inactive
detection_mode
enum<string>

Como os sinais são detectados. signal_first varre o mercado de forma ampla; company_first acompanha uma lista de contas nomeadas e exige ao menos uma empresa, domínio ou URL do LinkedIn. Imutável após a criação — alterá-lo em um monitor existente retorna 40021. Crie um novo monitor em vez disso.

Opções disponíveis:
company_first,
signal_first
signal_types
enum<string>[]

Tipos de sinais a monitorar.

Opções disponíveis:
jobs,
news,
advertisements,
expansions
signal_filters
object[]

Uma entrada por fluxo de sinal que o monitor observa.

Exemplo:
company_filters
object

Filtros globais de empresa aplicados como uma segunda camada em todos os tipos de sinal. Aceita os mesmos parâmetros do endpoint Company Search — localizações, número de funcionários, tecnologias, verticais e mais.

Exemplo:
companies
string<uuid>[]

Lista de UUIDs de domain_search_id de empresas a monitorar. Usado principalmente no modo company_first para especificar empresas-alvo. Você também pode usar domains ou linkedin_urls como alternativas — apenas um dos três é obrigatório.

domains
string[]

Lista de domínios de empresas a monitorar (por exemplo, ["openai.com", "google.com"]). Alternativa a companies — a Pubrio resolve esses valores para as empresas correspondentes. Apenas um dos parâmetros companies, domains ou linkedin_urls é obrigatório.

linkedin_urls
string<uri>[]

Lista de URLs de empresas no LinkedIn a monitorar (por exemplo, ["https://linkedin.com/company/pubrio"]). Alternativa a companies — a Pubrio resolve esses valores para as empresas correspondentes. Apenas um dos parâmetros companies, domains ou linkedin_urls é obrigatório.

is_company_enrichment
boolean

Se deve enriquecer dados de empresa nos resultados.

is_people_enrichment
boolean

Se deve enriquecer dados de pessoas nos resultados.

people_enrichment_configs
object[]

Array de camadas de enriquecimento de pessoas. Cada camada executa uma busca de pessoas independente. Contém max_people_to_return (1-25), people_contact_types (array — refere-se aos tipos de contato de Redeem: email-work, email-personal, phone) e filters (mesmos parâmetros do endpoint People Search).

Exemplo:
destination_type
enum<string>

Tipo de destino de entrega.

Opções disponíveis:
webhook,
email,
sequences
destination_config
object

Configuração do destino. Para webhook: exige webhook_url (string), com headers (objeto) e body (objeto) opcionais. Para email: aceita email (string) ou emails (array de strings). Para sequences: exige sequence_identifier (string) mais ao menos um de is_people_search_enrolled / is_company_contact_enrolled definido como true.

Exemplo:
frequency_minute
integer
padrão:0

Frequência de acionamento em minutos. Mín: 0, Máx: 10080, Padrão: 0.

Intervalo necessário: 0 <= x <= 10080
max_failure_trigger
integer
padrão:5

Número máximo de falhas consecutivas antes de pausar o monitor. Mín: 1, Máx: 10, Padrão: 5.

Intervalo necessário: 1 <= x <= 10
max_daily_trigger
integer
padrão:500

Número máximo de acionamentos por dia. Mín: 0, Máx: 86400, Padrão: 500.

Intervalo necessário: 0 <= x <= 86400
max_records_per_trigger
integer
padrão:25

Controla o número máximo de registros entregues por acionamento. Valores menores reduzem o tamanho do payload por entrega, o que é recomendado para conjuntos de resultados grandes ou integrações com limite de taxa. Mín: 1, Máx: 100, Padrão: 25. Veja Setting up Webhooks para orientações.

Intervalo necessário: 1 <= x <= 100
notification_email
string<email>

Endereço de e-mail para notificações de falha do monitor.

max_retry_per_trigger
integer
padrão:1

Número máximo de novas tentativas por acionamento. Mín: 0, Máx: 3, Padrão: 1.

Intervalo necessário: 0 <= x <= 3
retry_delay_second
integer
padrão:1

Intervalo entre novas tentativas, em segundos. Mín: 1, Máx: 5, Padrão: 1.

Intervalo necessário: 1 <= x <= 5
deep
boolean

Opcional, usado apenas com query. Executa a passagem de reflexão para maior precisão de interpretação (padrão true; aproximadamente dobra a latência de interpretação). Defina false para uma única passagem mais rápida.

Resposta

Resposta bem-sucedida contendo os detalhes do monitor recém-criado.

data
object