Mit der OpenReplay-API können Sie Benutzerdaten verwalten und erfasste Ereignisse für externe Analysen exportieren.

Verwenden Sie die Basis-URL der öffentlichen v2-API für alle neuen Integrationen. Alle Endpunkte authentifizieren sich über den Organization API Key. Jeder Pfad hat das Präfix /public.

• Cloud Serverless: https://api.openreplay.com/v2
• Cloud Dedicated / selbst gehostet: https://YOUR_INSTANCE_DOMAIN/v2/api

In der folgenden Dokumentation steht {BASE_URL} für die Basis-URL, die für Ihre Bereitstellung gilt.

Alle öffentlichen v2-API-Endpunkte werden mit dem Organization API Key (zu finden unter ‘Preferences’ > ‘Account’ > ‘Organization API Key’) authentifiziert, der als Bearer-Token gesendet wird:

Authorization: Bearer {YOUR_ORGANIZATION_API_KEY}

Erfolgreiche Antworten sind JSON und in { "data": ... } verpackt. Fehler werden als { "error": "<message>" } mit dem passenden HTTP-Statuscode (400, 401, 404, 409, 500, …) zurückgegeben.

Die unten aufgeführten v1-Endpunkte bleiben aus Gründen der Abwärtskompatibilität verfügbar, sind jedoch veraltet. Migrieren Sie zu den v2-Endpunkten.

• Für den Tarif Cloud Serverless: https://api.openreplay.com/api/v1
• Für Cloud Dedicated oder selbst gehostete Open-Source-Instanzen: https://YOUR_INSTANCE_DOMAIN/api/