API
OpenReplay API を使用すると、ユーザーデータを管理し、キャプチャしたイベントを外部分析用にエクスポートできます。
ベース URL(v2 - 現行)
Section titled ベース URL(v2 - 現行)新しいインテグレーションには、すべて v2 パブリック API のベース URL を使用してください。すべてのエンドポイントは Organization API Key で認証されます。すべてのルートには /public というプレフィックスが付きます。
- Cloud Serverless:
https://api.openreplay.com/v2 - Cloud Dedicated / セルフホスト:
https://YOUR_INSTANCE_DOMAIN/v2/api
以降のドキュメントでは、{BASE_URL} はご利用のデプロイに該当するベース URL を指します。
v2 パブリック API のすべてのエンドポイントは、Bearer トークンとして送信される Organization API Key(‘Preferences’ > ‘Account’ > ‘Organization API Key’ で確認できます)で認証されます。
Authorization: Bearer {YOUR_ORGANIZATION_API_KEY}
成功したレスポンスは JSON で、{ "data": ... } でラップされます。エラーは、適切な HTTP ステータスコード(400、401、404、409、500、…)とともに { "error": "<message>" } として返されます。
ベース URL(v1 - 非推奨)
Section titled ベース URL(v1 - 非推奨)以下の v1 エンドポイントは後方互換性のために引き続き利用できますが、非推奨です。v2 エンドポイントに移行してください。
- Cloud Serverless プランの場合:
https://api.openreplay.com/api/v1 - Cloud Dedicated またはオープンソースのセルフホストインスタンスの場合:
https://YOUR_INSTANCE_DOMAIN/api/