Skip to main content
POST
Créer un moniteur

Autorisations

pubrio-api-key
string
header
requis

Un jeton API unique qui représente les actions que vous effectuez via l'API ainsi que les autorisations et opérations correspondantes. Vous pouvez le créer dans la section Settings.

Corps

application/json
query
string
requis

Description en langage naturel du moniteur (dans n'importe quelle langue), par exemple : « surveiller les entreprises qui s'implantent au Japon, obtenir les cadres dirigeants avec leur e-mail professionnel, et envoyer des alertes par e-mail à [email protected] en temps réel ». Elle est interprétée dans les champs ci-dessous (detection_mode, signal_types, signal_filters, people_enrichment_configs, destination_type/destination_config, frequency_minute) au sein de la même requête. Tout champ également transmis explicitement remplace la valeur interprétée. Si le texte ne constitue pas une demande de moniteur, l'appel renvoie 400. Limité à 2000 caractères.

Maximum string length: 2000
name
string

Nom du monitor.

description
string

Description du monitor.

status
enum<string>
défaut:active

Statut de cycle de vie avec lequel créer le monitor. Par défaut sur active. Utilisez draft pour enregistrer un monitor à moitié construit : seul name est requis, la validation est différée jusqu'à son activation, et un brouillon ne s'exécute jamais.

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

Comment les signaux sont détectés. signal_first scanne largement le marché ; company_first suit une liste de comptes nommés et nécessite au moins une entreprise, un domaine ou une URL LinkedIn. Immuable après la création — le modifier sur un monitor existant renvoie 40021. Créez plutôt un nouveau monitor.

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

Types de signaux à surveiller.

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

Une entrée par flux de signal que le monitor surveille.

Exemple:
company_filters
object

Filtres d'entreprise globaux appliqués comme seconde couche sur tous les types de signaux. Accepte les mêmes paramètres que le point de terminaison Company Search — localisations, effectifs, technologies, secteurs, et plus.

Exemple:
companies
string<uuid>[]

Liste d'UUID domain_search_id d'entreprises à surveiller. Utilisé principalement en mode company_first pour préciser les entreprises cibles. Vous pouvez aussi utiliser domains ou linkedin_urls comme alternatives — un seul des trois est requis.

domains
string[]

Liste de domaines d'entreprise à surveiller (par ex. ["openai.com", "google.com"]). Alternative à companies — Pubrio les résout vers les entreprises correspondantes. Un seul de companies, domains, ou linkedin_urls est requis.

linkedin_urls
string<uri>[]

Liste d'URL d'entreprise LinkedIn à surveiller (par ex. ["https://linkedin.com/company/pubrio"]). Alternative à companies — Pubrio les résout vers les entreprises correspondantes. Un seul de companies, domains, ou linkedin_urls est requis.

is_company_enrichment
boolean

Indique s'il faut enrichir les données d'entreprise dans les résultats.

is_people_enrichment
boolean

Indique s'il faut enrichir les données de personnes dans les résultats.

people_enrichment_configs
object[]

Tableau de couches d'enrichissement de personnes. Chaque couche exécute une recherche de personnes indépendante. Contient max_people_to_return (1-25), people_contact_types (tableau — fait référence aux types de contact Redeem : email-work, email-personal, phone), et filters (mêmes paramètres que le point de terminaison People Search).

Exemple:
destination_type
enum<string>

Type de destination de livraison.

Options disponibles:
webhook,
email,
sequences
destination_config
object

Configuration de la destination. Pour webhook : nécessite webhook_url (chaîne), headers (objet) et body (objet) optionnels. Pour email : accepte email (chaîne) ou emails (tableau de chaînes). Pour sequences : nécessite sequence_identifier (chaîne) plus au moins un de is_people_search_enrolled / is_company_contact_enrolled défini sur true.

Exemple:
frequency_minute
integer
défaut:0

Fréquence de déclenchement en minutes. Min : 0, Max : 10080, Par défaut : 0.

Plage requise: 0 <= x <= 10080
max_failure_trigger
integer
défaut:5

Nombre maximal d'échecs consécutifs avant la mise en pause du moniteur. Min : 1, Max : 10, Par défaut : 5.

Plage requise: 1 <= x <= 10
max_daily_trigger
integer
défaut:500

Nombre maximal de déclenchements par jour. Min : 0, Max : 86400, Par défaut : 500.

Plage requise: 0 <= x <= 86400
max_records_per_trigger
integer
défaut:25

Contrôle le nombre maximal d'enregistrements livrés par déclenchement. Des valeurs plus faibles réduisent la taille de la charge utile par livraison, ce qui est recommandé pour les jeux de résultats volumineux ou les intégrations à débit limité. Min : 1, Max : 100, Par défaut : 25. Consultez Configuration des webhooks pour plus d'indications.

Plage requise: 1 <= x <= 100
notification_email
string<email>

Adresse e-mail pour les notifications d'échec du moniteur.

max_retry_per_trigger
integer
défaut:1

Nombre maximal de nouvelles tentatives par déclenchement. Min : 0, Max : 3, Par défaut : 1.

Plage requise: 0 <= x <= 3
retry_delay_second
integer
défaut:1

Délai entre les tentatives, en secondes. Min : 1, Max : 5, Par défaut : 1.

Plage requise: 1 <= x <= 5
deep
boolean

Facultatif, utilisé uniquement avec query. Exécute la passe de réflexion pour une meilleure précision d'interprétation (valeur par défaut : true ; double environ la latence d'interprétation). Définissez false pour une passe unique plus rapide.

Réponse

Réponse réussie contenant les détails du monitor nouvellement créé.

data
object