L’API OpenReplay vous permet de gérer les données utilisateur et d’exporter les événements capturés en vue d’une analyse externe.

Utilisez l’URL de base de l’API publique v2 pour toutes les nouvelles intégrations. Tous les endpoints s’authentifient via la clé API de l’organisation. Chaque route est préfixée par /public.

• Cloud Serverless : https://api.openreplay.com/v2
• Cloud Dedicated / auto-hébergé : https://YOUR_INSTANCE_DOMAIN/api/v2

Tout au long de la documentation ci-dessous, {BASE_URL} désigne l’URL de base qui correspond à votre déploiement.

Tous les endpoints de l’API publique v2 sont authentifiés à l’aide de la clé API de l’organisation (que vous trouverez dans ‘Preferences’ > ‘Account’ > ‘Organization API Key’) envoyée sous forme de token Bearer :

Authorization: Bearer {YOUR_ORGANIZATION_API_KEY}

Les réponses réussies sont au format JSON et encapsulées dans { "data": ... }. Les erreurs sont renvoyées sous la forme { "error": "<message>" } avec le code de statut HTTP approprié (400, 401, 404, 409, 500, …).

Les endpoints v1 ci-dessous restent disponibles pour des raisons de rétrocompatibilité, mais ils sont obsolètes. Migrez vers les endpoints v2.

• Pour le plan Cloud Serverless : https://api.openreplay.com/api/v1
• Pour les instances Cloud Dedicated ou open source auto-hébergées : https://YOUR_INSTANCE_DOMAIN/api/