Skip to main content
En complément des webhooks (qui vous poussent les événements), l’API vous permet de tirer la donnée à la demande : résultats de campagnes, risk scores radar et statut des formations. Toutes ces lectures sont scopées à votre entreprise.

Permissions

Chaque famille a sa propre permission — créez une clé au plus juste.
Un connecteur SIEM qui n’a besoin que des résultats de phishing prendra read:results seul, sans accéder aux données RH (radar, formations).

Pagination

Toutes les listes suivent la même enveloppe et les mêmes paramètres.
  • page (défaut 1) et limit (défaut 50, max 100 — au-delà, ramené à 100).
  • from / to filtrent par période (format YYYY-MM-DD). Par défaut : les 30 derniers jours.
  • Itérez tant que pagination.has_more vaut true.

Ce que vous obtenez

Résultats de campagnes

Taux d’ouverture, de clic, de soumission et de signalement par campagne, puis le détail par employé. Les adresses IP ne sont jamais exposées (RGPD).

Risk scores (radar)

Un score 0-100 par axe de sécurité, pour un employé ou agrégé sur toute l’entreprise, avec l’axe le plus faible mis en évidence.

Statut des formations

Pour chaque assignation : statut, progression (% de vidéos terminées) et score de quiz moyen.

Synthèse analytics

Totaux et taux moyens sur une période, plus l’évolution mensuelle — idéal pour un tableau de bord de direction.

Fraîcheur et limites

  • Les réponses sont mises en cache 60 secondes côté serveur : deux appels identiques rapprochés renvoient la même donnée. Suffisant pour du reporting, pas conçu pour du suivi à la seconde (utilisez les webhooks pour le temps réel).
  • La limite de débit standard s’applique : 600 requêtes / 15 minutes par clé.

Voir tous les endpoints

Chemins, paramètres et schémas de réponse détaillés dans la référence API.