A API do OpenReplay permite gerenciar dados de usuários e exportar eventos capturados para análise externa.

Use a URL base da API pública v2 em todas as novas integrações. Todos os endpoints são autenticados por meio da Organization API Key. Todas as rotas têm o prefixo /public.

• Cloud Serverless: https://api.openreplay.com/v2
• Cloud Dedicated / auto-hospedado: https://YOUR_INSTANCE_DOMAIN/v2/api

Em toda a documentação abaixo, {BASE_URL} se refere à URL base que se aplica à sua implantação.

Todos os endpoints da API pública v2 são autenticados com a Organization API Key (encontrada em ‘Preferences’ > ‘Account’ > ‘Organization API Key’) enviada como um token Bearer:

Authorization: Bearer {YOUR_ORGANIZATION_API_KEY}

As respostas bem-sucedidas são JSON e vêm encapsuladas em { "data": ... }. Os erros são retornados como { "error": "<message>" } com o código de status HTTP apropriado (400, 401, 404, 409, 500, …).

Os endpoints v1 abaixo continuam disponíveis para compatibilidade com versões anteriores, mas estão descontinuados. Migre para os endpoints v2.

• Para o plano Cloud Serverless: https://api.openreplay.com/api/v1
• Para instâncias Cloud Dedicated ou de código aberto auto-hospedadas: https://YOUR_INSTANCE_DOMAIN/api/