Cerca gli utenti in un progetto. Filtra per attributi (ID utente, email, paese, ecc.), restringi facoltativamente con una query di testo libero e pagina i risultati.

POST

/public/:projectKey/users

Authorization: Bearer {YOUR_ORGANIZATION_API_KEY}

curl -X POST \
  {BASE_URL}/public/3sWXSsqHgSKnE87YkNJK/users \
  -H 'content-type: application/json' \
  -H 'Authorization: Bearer {YOUR_ORGANIZATION_API_KEY}' \
  --data-raw '{
    "query": "mickael",
    "limit": 50,
    "page":  1,
    "sortOrder": "desc"
  }'

{
  "data": {
    "total": 1,
    "users": [
      {
        "$user_id": "mickael@openreplay.com",
        "$email": "mickael@openreplay.com",
        "$name": "Mickael",
        "$first_name": "Mickael",
        "$last_name": "",
        "$created_at": 1623440822825,
        "$last_seen": 1623689478617
      }
    ]
  }
}

Ottieni gli attributi di identità e le statistiche di alto livello di un determinato utente.

GET

/public/:projectKey/users/:userId

Authorization: Bearer {YOUR_ORGANIZATION_API_KEY}

200: risposta inviata come JSON nel body
400: userId non valido (vuoto o > 256 caratteri)
404: utente non trovato

curl -X GET \
  {BASE_URL}/public/3sWXSsqHgSKnE87YkNJK/users/mickael@openreplay.com \
  -H 'Authorization: Bearer {YOUR_ORGANIZATION_API_KEY}'

{
  "data": {
    "$user_id": "mickael@openreplay.com",
    "$email": "mickael@openreplay.com",
    "$name": "Mickael",
    "$first_name": "Mickael",
    "$last_name": "",
    "$phone": "",
    "$avatar": "",
    "$created_at": 1623440822825,
    "distinct_ids": ["15bd70f6-aedf-4544-8ae6-57eb66398e94"],
    "$country": "FR",
    "$state": "",
    "$city": "",
    "$first_event_at": 1623440822825,
    "$last_seen": 1623689478617
  }
}

Elimina un utente e tutti i dati associati. Pianifica un job in background; la risposta contiene il jobId che puoi interrogare tramite l’API Jobs.

DELETE

/public/:projectKey/users/:userId

Authorization: Bearer {YOUR_ORGANIZATION_API_KEY}

200: job pianificato, restituito nel body
400: userId non valido (vuoto o > 256 caratteri)
409: un job di eliminazione per questo utente è già pianificato o in esecuzione

curl -X DELETE \
  {BASE_URL}/public/3sWXSsqHgSKnE87YkNJK/users/mickael@example.com \
  -H 'Authorization: Bearer {YOUR_ORGANIZATION_API_KEY}'

{
  "data": {
    "jobId": 22345,
    "description": "Delete user sessions of userId = mickael@example.com",
    "status": "scheduled",
    "projectId": 1,
    "action": "delete_user_data",
    "referenceId": "mickael@example.com",
    "createdAt": 1623912962910,
    "updatedAt": null,
    "startAt": 1623954600000,
    "errors": null
  }
}

Il job di eliminazione è un processo in due fasi: prima, le sessioni e i relativi eventi a cascata vengono eliminati dal database durante la notte; poi, i file di replay vengono pianificati per la scadenza (dopo 30 giorni) nell’object storage.

Se utilizzi minio (installazione standard) e vuoi modificare la policy predefinita di scadenza/ciclo di vita, segui le istruzioni riportate di seguito:

1. Sul tuo server, esegui openreplay -e
2. Nella sezione chalice, definisci una nuova variabile d’ambiente chiamata SCH_DELETE_DAYS con un valore pari al numero di giorni per cui vuoi conservare il file di replay prima dell’eliminazione (maggiore o uguale a 0)
3. Salva ed esci con :wq
4. Esegui k9s -n db
5. Usa le frecce della tastiera per scorrere l’elenco e raggiungere il container minio-*
6. Premi s per ottenere l’accesso shell al container Minio (object storage)
7. Esegui mc alias set minio http://localhost:9000 $MINIO_ACCESS_KEY $MINIO_SECRET_KEY
8. Per eliminare i file di replay 14 giorni dopo l’esecuzione del job di eliminazione

export EXPIRATION_DAYS=14
mc ilm add --expiry-days $EXPIRATION_DAYS --tags "to_delete_in_days=${EXPIRATION_DAYS}" minio/mobs

9. Usa exit per uscire dal container Minio
10. Esegui :quit per uscire dalla CLI di Kubernetes