Utilisateurs
Obtenir les statistiques d’un utilisateur
Section titled Obtenir les statistiques d’un utilisateurObtenez quelques statistiques générales et des détails sur un utilisateur particulier, qui a été identifié via la fonction JavaScript tracker.setUserID. Ce endpoint renvoie des informations telles que firstSeen, lastSeen et numberSessions.
Méthode
Section titled MéthodeGET
/api/v1/:projectKey/users/:userId
Paramètres
Section titled Paramètres| Nom | Type | Description |
|---|---|---|
| projectKey | string | L’ID du projet que vous suivez (obligatoire) |
| userId | string | L’ID de votre utilisateur, défini via tracker.setUserID (obligatoire) |
En-têtes de la requête
Section titled En-têtes de la requêteAuthorization: {YOUR_ORGANIZATION_API_KEY} : La clé se trouve dans ‘Preferences’ > ‘Account’ > ‘Organization API Key’.
Codes de statut
Section titled Codes de statut200 : Réponse envoyée au format JSON dans le corps
Exemple de requête
Section titled Exemple de requêtecurl -X GET \
https://openreplay.example.com/api/v1/3sWXSsqHgSKnE87YkNJK/users/mickael@openreplay.com \
-H 'content-type: application/json' \
-H 'Authorization: {YOUR_ORGANIZATION_API_KEY}'
Exemple de réponse
Section titled Exemple de réponse{
"data": {
"userId": "mickael@openreplay.com",
"sessionCount": 3,
"lastSeen": 1623689478617,
"firstSeen": 1623440822825
}
}
Supprimer un utilisateur
Section titled Supprimer un utilisateurSupprimez un utilisateur (identifié via la fonction JavaScript tracker.setUserID) ainsi que toutes ses données capturées par OpenReplay. Cela déclenche une tâche en arrière-plan exécutée une seule fois pour supprimer toutes les données liées à l’utilisateur, y compris les sessions, les événements, les métadonnées, les événements personnalisés et les enregistrements. L’appel renvoie un jobID que vous pourrez utiliser ultérieurement pour vérifier l’état de l’opération de suppression.
Cela s’avère pratique pour traiter les demandes liées au RGPD que vous pourriez recevoir de vos utilisateurs finaux.
Méthode
Section titled MéthodeDELETE
/api/v1/:projectKey/users/:userId
Paramètres
Section titled Paramètres| Nom | Type | Description |
|---|---|---|
| projectKey | string | L’ID du projet que vous suivez (obligatoire) |
| userId | string | L’ID de votre utilisateur, défini via tracker.setUserID (obligatoire) |
En-têtes de la requête
Section titled En-têtes de la requêteAuthorization: {YOUR_ORGANIZATION_API_KEY} : La clé se trouve dans ‘Preferences’ > ‘Account’ > ‘Organization API Key’.
Codes de statut
Section titled Codes de statut200 : Réponse envoyée au format JSON dans le corps
Exemple de requête
Section titled Exemple de requêtecurl -X DELETE \
https://openreplay.example.com/api/v1/3sWXSsqHgSKnE87YkNJK/users/mickael@example.com \
-H 'content-type: application/json' \
-H 'Authorization: {YOUR_ORGANIZATION_API_KEY}'
Exemple de réponse
Section titled Exemple de réponse{
"data": {
"jobId": 22345,
"description": "Delete user sessions of userId = mickael@example.com",
"status": "scheduled",
"projectId": 1,
"action": "delete_user_data",
"referenceId": "mehdi@openreplay.com",
"createdAt": 1623912962910,
"updatedAt": 1623912962910,
"startAt": 1623954600000,
"errors": null
}
}
Modifier le délai de suppression du fichier de replay ?
Section titled Modifier le délai de suppression du fichier de replay ?La tâche de suppression se déroule en 2 étapes : Premièrement, les sessions et leurs événements en cascade sont supprimés de la base de données pendant la nuit. Deuxièmement, l’expiration des fichiers de replay est programmée (dans 30 jours) dans le stockage d’objets.
Si vous utilisez minio (installation standard) et que vous souhaitez modifier la politique d’expiration/de cycle de vie par défaut, suivez les instructions ci-dessous :
- Sur votre serveur, exécutez
openreplay -e - Dans la section
chalice, définissez une nouvelle variable d’environnement nommée SCH_DELETE_DAYS avec une valeur égale au nombre de jours pendant lesquels vous souhaitez conserver le fichier de replay avant sa suppression (supérieur ou égal à 0) - Enregistrez et quittez avec
:wq - Exécutez
k9s -n db - Utilisez les flèches du clavier pour parcourir la liste et atteindre le conteneur
minio-* - Appuyez sur
spour accéder au shell du conteneur Minio (stockage d’objets) - Exécutez
mc alias set minio http://localhost:9000 $MINIO_ACCESS_KEY $MINIO_SECRET_KEY - Pour supprimer les fichiers de replay 14 jours après l’exécution de la tâche de suppression
export EXPIRATION_DAYS=14
mc ilm add --expiry-days $EXPIRATION_DAYS --tags "to_delete_in_days=${EXPIRATION_DAYS}" minio/mobs
- Utilisez
exitpour quitter le conteneur Minio - Exécutez
:quitpour quitter la CLI de Kubernetes