Proyectos

Crear proyecto

Crea un nuevo proyecto especificando su name.

Método

POST

URL

/api/v1/projects

Parámetros

Nombre	Tipo	Descripción
name	string	El nombre del proyecto que estás creando (p. ej. MyApp, Production, Staging) (obligatorio)

Encabezados de la solicitud

Authorization: {YOUR_ORGANIZATION_API_KEY}: La clave se encuentra en ‘Preferences’ > ‘Account’ > ‘Organization API Key’.

Códigos de estado

200: Respuesta enviada como JSON en el cuerpo

Ejemplo de solicitud

curl -X POST \
  https://openreplay.example.com/api/v1/projects/MyFirstProject \
  -H 'content-type: application/json' \
  -H 'Authorization: {YOUR_ORGANIZATION_API_KEY}'
  --data-raw '{
    "name": "MyFirstProject"
}'

Ejemplo de respuesta

{
  "data": {
    "projectKey": "QsLA07Oa5sqTfwnNaFwS",
    "name": "MyFirstProject",
    "gdpr": {
      "maskEmails": true,
      "sampleRate": 50,
      "maskNumbers": true,
      "defaultInputMode": "plain"
    }
  }
}

Obtener proyecto

Devuelve los detalles del proyecto especificado.

Método

GET

URL

/api/v1/projects/:projectKey

Parámetros

Nombre	Tipo	Descripción
projectKey	string	El ID del proyecto que estás siguiendo (obligatorio)

Encabezados de la solicitud

Authorization: {YOUR_ORGANIZATION_API_KEY}: La clave se encuentra en ‘Preferences’ > ‘Account’ > ‘Organization API Key’.

Códigos de estado

200: Respuesta enviada como JSON en el cuerpo

Ejemplo de solicitud

curl -X GET \
  https://openreplay.example.com/api/v1/projects/7ePSXFuQVidq9pqS6Xyn \
  -H 'content-type: application/json' \
  -H 'Authorization: {YOUR_ORGANIZATION_API_KEY}'

Ejemplo de respuesta

{
  "data": {
    "projectKey": "7ePSXFuQVidq9pqS6Xyn",
    "name": "MyFirstProject"
  }
}

Obtener proyectos

Devuelve la lista de proyectos existentes.

Método

GET

URL

/api/v1/projects

Encabezados de la solicitud

Authorization: {YOUR_ORGANIZATION_API_KEY}: La clave se encuentra en ‘Preferences’ > ‘Account’ > ‘Organization API Key’.

Códigos de estado

200: Respuesta enviada como JSON en el cuerpo

Ejemplo de solicitud

curl -X GET \
  https://openreplay.example.com/api/v1/projects \
  -H 'content-type: application/json' \
  -H 'Authorization: {YOUR_ORGANIZATION_API_KEY}'

Ejemplo de respuesta

{
  "data": {
    "projectKey": "7ePSXFuQVidq9pqS6Xyn",
    "name": "MyFirstProject"
  },
  {
    "projectKey": "9cACFRuQVidq0sqS7Bny",
    "name": "MySecondProject"
  }
}