API OpenReplay позволяет управлять данными пользователей и экспортировать захваченные события для внешнего анализа.

Используйте базовый URL публичного API v2 для всех новых интеграций. Все эндпоинты аутентифицируются с помощью API-ключа организации. Каждый маршрут имеет префикс /public.

• Cloud Serverless: https://api.openreplay.com/v2
• Cloud Dedicated / собственный хостинг: https://YOUR_INSTANCE_DOMAIN/api/v2

В документации ниже {BASE_URL} обозначает тот базовый URL, который применим к вашему развёртыванию.

Все эндпоинты публичного API v2 аутентифицируются с помощью API-ключа организации (находится в разделе ‘Preferences’ > ‘Account’ > ‘Organization API Key’), который передаётся в виде токена Bearer:

Authorization: Bearer {YOUR_ORGANIZATION_API_KEY}

Успешные ответы возвращаются в формате JSON и обёрнуты в { "data": ... }. Ошибки возвращаются в виде { "error": "<message>" } с соответствующим кодом состояния HTTP (400, 401, 404, 409, 500, …).

Приведённые ниже эндпоинты v1 по-прежнему доступны для обратной совместимости, но являются устаревшими. Перейдите на эндпоинты v2.

• Для плана Cloud Serverless: https://api.openreplay.com/api/v1
• Для инстансов Cloud Dedicated или открытых инстансов с собственным хостингом: https://YOUR_INSTANCE_DOMAIN/api/