mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
f06a3c920d
* docs: document user flow analytics * docs: polish analytics metadata * docs: clarify user flow aggregation * docs: refine analytics writing style * docs: document impressions actions metrics * docs: refine analytics prose * docs: document search funnel actions * docs: improve funnel prose * docs: clarify impressions card order * update user engagement info --------- Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
409 lines
24 KiB
Plaintext
409 lines
24 KiB
Plaintext
---
|
|
title: "Analytique"
|
|
description: "Suivez le trafic, les tendances de recherche, l'utilisation de l'assistant et les retours des utilisateurs dans le tableau de bord d'analytique Mintlify."
|
|
keywords: ["analytics","metrics","page views","traffic","trends","insights","impressions","CTA","call-to-action"]
|
|
boost: 3
|
|
---
|
|
|
|
<Info>
|
|
L'analytique nécessite un [plan Pro ou Enterprise](https://mintlify.com/pricing?ref=analytics).
|
|
</Info>
|
|
|
|
La page [analytics](https://app.mintlify.com/analytics) de votre tableau de bord présente des données sur les visiteurs de votre site, la manière dont ils interagissent avec l'assistant, ce qu'ils recherchent et leurs retours. Utilisez ces informations pour identifier les pages les plus utiles à vos utilisateurs et suivre les tendances au fil du temps.
|
|
|
|
Les données d'analytique se mettent à jour avec un léger décalage, généralement en quelques minutes après l'interaction. Les événements très récents peuvent ne pas apparaître immédiatement.
|
|
|
|
<div id="traffic">
|
|
## Trafic
|
|
</div>
|
|
|
|
La section Trafic de la page d'analytique affiche le nombre total de visiteurs, de pages vues, de conversations avec l'assistant, de recherches et de messages de retour des utilisateurs.
|
|
|
|
Examinez vos analyses de trafic pour :
|
|
|
|
- **Surveiller les tendances du trafic** : observez les évolutions du trafic humain et agent après des mises à jour ou de nouveaux contenus pour comprendre l'impact de vos changements.
|
|
- **Identifier les pages populaires** : utilisez les pages les mieux classées pour comprendre quels contenus sont les plus importants pour vos utilisateurs afin de vous assurer qu'ils restent à jour et complets.
|
|
- **Suivre les sources de référence** : comprenez d'où viennent vos utilisateurs pour vous aider à optimiser votre contenu pour la bonne audience.
|
|
|
|
<Frame>
|
|
<img
|
|
src="/images/analytics/traffic-light.png"
|
|
alt="La section Trafic de la page d'analytique."
|
|
className="block dark:hidden"
|
|
/>
|
|
|
|
<img
|
|
src="/images/analytics/traffic-dark.png"
|
|
alt="La section Trafic de la page d'analytique."
|
|
className="hidden dark:block"
|
|
/>
|
|
</Frame>
|
|
|
|
<div id="agent-views">
|
|
### Vues des agents
|
|
</div>
|
|
|
|
Mintlify identifie les visiteurs agents par adresse IP et user agent. Le nombre de visiteurs agents estime les sources distinctes de trafic IA plutôt que les sessions ou conversations individuelles d'agents. Plusieurs requêtes provenant de la même adresse IP comptent comme un seul visiteur.
|
|
|
|
Utilisez les vues des agents pour vous aider à déterminer :
|
|
|
|
- **Répartition des agents IA** : voyez quelles plateformes d'IA accèdent à votre documentation pour découvrir quels outils vos utilisateurs préfèrent.
|
|
- **Opportunités d'intégration** : identifiez les plateformes d'IA à prioriser pour l'optimisation et les tests.
|
|
- **Modèles de trafic IA** : surveillez quels agents sont les plus actifs et comment leur utilisation évolue au fil du temps.
|
|
|
|
<div id="assistant">
|
|
## Assistant
|
|
</div>
|
|
|
|
La section Assistant de la page d'analytique affiche l'utilisation de l'assistant dans le temps ainsi qu'une carte des conversations avec deux vues.
|
|
|
|
- **Catégories de conversations** regroupe les conversations en catégories et sujets. Sélectionnez une catégorie pour voir ses sujets, puis sélectionnez un sujet pour ouvrir un panneau contenant des indicateurs de satisfaction et toutes les conversations de ce sujet.
|
|
- **Toutes les conversations** liste toutes les conversations de l'assistant pour la plage de dates sélectionnée, avec un badge de retour sur chaque ligne. Sélectionnez une conversation pour ouvrir la transcription complète.
|
|
|
|
Utilisez le menu déroulant **Filtrer** pour restreindre l'une ou l'autre vue aux conversations avec un retour **Positif** ou **Négatif**. Les filtres de retour sont appliqués côté serveur, de sorte que les résultats restent complets d'une page à l'autre.
|
|
|
|
Examinez vos analyses de l'assistant pour :
|
|
|
|
- **Surveiller l'utilisation de l'assistant** : observez les évolutions de l'utilisation de l'assistant pour comprendre comment vos utilisateurs interagissent avec votre contenu.
|
|
- **Identifier les sujets fréquents** : explorez les catégories et les sujets pour comprendre ce sur quoi vos utilisateurs posent le plus de questions. Repérez les lacunes de couverture et priorisez les mises à jour du contenu.
|
|
- **Repérer les points de friction** : filtrez par retours négatifs pour voir quelles conversations les utilisateurs ont mal notées et priorisez l'amélioration du contenu sous-jacent.
|
|
- **Consulter l'historique des conversations** : obtenez des données détaillées à forte intention sur la façon dont vos utilisateurs perçoivent votre produit en examinant leurs conversations avec l'assistant. Voyez les termes qu'ils emploient, ce sur quoi ils ont besoin d'aide et les tâches qu'ils cherchent à accomplir.
|
|
|
|
<Frame>
|
|
<img
|
|
src="/images/analytics/assistant-light.png"
|
|
alt="La section Assistant de la page d'analytique."
|
|
className="block dark:hidden"
|
|
/>
|
|
|
|
<img
|
|
src="/images/analytics/assistant-dark.png"
|
|
alt="La section Assistant de la page d'analytique."
|
|
className="hidden dark:block"
|
|
/>
|
|
</Frame>
|
|
|
|
<div id="search">
|
|
## Recherche
|
|
</div>
|
|
|
|
La section Recherche de la page d'analytique affiche le volume de recherches, les requêtes sans résultats et les taux de clic.
|
|
|
|
Examinez vos analyses de recherche pour :
|
|
|
|
- **Surveiller les tendances de recherche** : observez les évolutions des requêtes de recherche pour comprendre comment vos utilisateurs trouvent votre contenu et sur quels sujets ils souhaitent des informations.
|
|
- **Identifier les requêtes fréquentes** : utilisez les requêtes fréquentes pour comprendre quels sujets sont les plus importants pour vos utilisateurs. Repérez les lacunes de couverture et priorisez les mises à jour du contenu.
|
|
- **Identifier les faibles taux de clic** : le taux de clic (CTR) indique combien d'utilisateurs cliquent sur un résultat de recherche après avoir saisi une requête. Un CTR faible peut indiquer que les résultats de recherche ne sont pas pertinents par rapport aux requêtes des utilisateurs. Si vous avez des termes de recherche fréquents avec un CTR faible, envisagez d'améliorer la pertinence des résultats de recherche en ajoutant des mots-clés et en mettant à jour votre contenu.
|
|
|
|
<Frame>
|
|
<img
|
|
src="/images/analytics/search-light.png"
|
|
alt="La section Recherche de la page d'analytique."
|
|
className="block dark:hidden"
|
|
/>
|
|
|
|
<img
|
|
src="/images/analytics/search-dark.png"
|
|
alt="La section Recherche de la page d'analytique."
|
|
className="hidden dark:block"
|
|
/>
|
|
</Frame>
|
|
|
|
<div id="user-engagements">
|
|
## Engagement des utilisateurs
|
|
</div>
|
|
|
|
La section Engagement des utilisateurs montre comment les visiteurs interagissent avec votre contenu et vos appels à l'action. Elle comprend une vue d'ensemble, les tendances d'interaction par page, les parcours fréquents dans la documentation et les entonnoirs de recherche et de l'assistant. Toutes les cartes utilisent la période sélectionnée pour cette section.
|
|
|
|
<div id="interactions-overview">
|
|
### Vue d'ensemble
|
|
</div>
|
|
|
|
La carte **Vue d'ensemble** affiche :
|
|
|
|
- **Total des interactions** : Les clics sur les CTA et les actions au niveau des pages combinés.
|
|
- **Nombre moyen d'interactions par session** : Le total des interactions divisé par le nombre de sessions ayant enregistré un CTA, une action ou une vue de page.
|
|
- **Taux de clic du CTA** : Le nombre de clics sur les CTA divisé par le nombre de pages vues par des humains, avec un maximum de 100 %.
|
|
|
|
Chaque indicateur comprend un badge de variation qui compare la période sélectionnée à la période précédente de même durée.
|
|
|
|
<div id="actions-over-time">
|
|
### Actions effectuées au fil du temps
|
|
</div>
|
|
|
|
Le graphique **Actions effectuées au fil du temps** suit deux séries distinctes :
|
|
|
|
- **Clics sur le CTA** : Les clics sur le [bouton principal de la barre de navigation](/fr/organize/settings-structure#navbar). Cette série nécessite un bouton `navbar.primary` dans `docs.json`.
|
|
- **Actions** : Les actions du menu contextuel, les copies de blocs de code, les requêtes du playground d'API et les retours positifs ou négatifs.
|
|
|
|
Le tableau classe les pages selon le total des clics et des actions. Il inclut les vues de page, les clics, le taux de CTA, les actions et le taux d'actions. Le taux de CTA correspond aux clics sur les CTA divisés par les vues humaines. Le taux d'actions correspond aux actions divisées par les vues humaines.
|
|
|
|
<div id="user-flow">
|
|
### Parcours utilisateurs
|
|
</div>
|
|
|
|
La carte **Parcours utilisateurs** montre les chemins suivis après l'arrivée dans la documentation depuis une page sélectionnée. Le sélecteur répertorie jusqu'à dix pages ayant le plus de sessions initiales. Le graphique suit les sessions à travers la page d'entrée et jusqu'à trois interactions de page suivantes.
|
|
|
|
Pour interpréter un parcours :
|
|
|
|
1. Sélectionnez une page d'entrée.
|
|
2. Survolez un nœud pour voir les sessions entrantes (**Entrées**), les sessions qui continuent (**Sorties**) et le taux d'abandon, lorsqu'il est disponible.
|
|
|
|
Chaque colonne affiche jusqu'à six pages nommées, classées selon les sessions entrantes. Les autres sont regroupées dans un nœud **Other (N pages)** en bas de la colonne. Ce regroupement conserve les sessions qui continuent, de sorte que l'abandon reflète les visiteurs qui ne poursuivent pas. La dernière colonne n'affiche pas d'abandon, car le graphique ne montre pas de page suivante.
|
|
|
|
Utilisez les parcours pour identifier les chemins fréquents, trouver les pages où les visiteurs s'arrêtent et comparer les habitudes entre les pages d'entrée ou les périodes. Aucune configuration du site n'est nécessaire. Lorsque cette carte est disponible pour votre déploiement, les données apparaissent après que votre documentation reçoit du trafic.
|
|
|
|
<div id="user-funnel">
|
|
### Entonnoir utilisateur
|
|
</div>
|
|
|
|
La carte **Entonnoir utilisateur** compte les sessions à chaque étape et indique combien ont atteint l'étape ou l'ont abandonnée auparavant. Utilisez le sélecteur pour basculer entre **Recherche vers réponse**, la vue par défaut, et **Conversation avec l'assistant**.
|
|
|
|
#### Recherche vers réponse
|
|
|
|
| Étape | Description |
|
|
| --- | --- |
|
|
| **Recherche ouverte** | La session a ouvert l'interface de recherche. Cette étape apparaît uniquement pour les périodes commençant le 31 juillet 2026 ou après et contenant des événements d'ouverture. |
|
|
| **Requête saisie** | La session a envoyé une requête de recherche. |
|
|
| **Résultat sélectionné** | La session a cliqué sur un résultat de recherche. |
|
|
| **Page consultée** | La session a consulté la page ouverte depuis un résultat de recherche. |
|
|
| **Action effectuée** | Après la consultation, la session a cliqué sur un CTA, utilisé une action du menu contextuel, copié un bloc de code, envoyé une requête du playground d'API ou soumis un retour positif ou négatif. |
|
|
|
|
Utilisez les abandons entre les étapes pour déterminer si les visiteurs ont du mal à rechercher, à choisir un résultat, à atteindre sa page ou à continuer d'interagir.
|
|
|
|
#### Conversation avec l'assistant
|
|
|
|
L'entonnoir de l'assistant exclut les sessions signalées comme spam et comprend ces étapes :
|
|
|
|
| Étape | Description |
|
|
| --- | --- |
|
|
| **Conversation démarrée** | La session contenait une activité de l'assistant. |
|
|
| **Réponse obtenue** | L'assistant a terminé au moins une réponse au cours de la session. |
|
|
| **Question de suivi** | L'assistant a terminé au moins deux réponses au cours de la session. |
|
|
| **Interaction avec la réponse** | La même session contenait au moins une réponse terminée et un clic sur une source, une copie de réponse, un clic sur un résultat de recherche web ou un retour positif ou négatif. |
|
|
|
|
L'étape Interaction n'exige pas que l'événement ait lieu après la réponse terminée ni qu'une question de suivi ait été posée.
|
|
|
|
Examinez vos analyses de l'engagement des utilisateurs pour :
|
|
|
|
- **Identifier les pages à forte intention** : les pages présentant un taux de clic du CTA élevé indiquent souvent des visiteurs prêts à passer à l'étape suivante, comme s'inscrire à votre produit ou contacter votre équipe commerciale.
|
|
- **Comprendre quel contenu compte pour vos utilisateurs** : examinez les pages à forte intention pour découvrir quel contenu incite les utilisateurs à s'engager plus profondément avec votre produit ou service. Veillez à ce que ces pages soient bien tenues à jour et envisagez d'ajouter davantage de contenu connexe si nécessaire.
|
|
|
|
<div id="feedback">
|
|
## Retours
|
|
</div>
|
|
|
|
L'onglet Retours affiche un graphique à barres des retours dans le temps ainsi que les éléments de retour spécifiques.
|
|
|
|
Consultez [Retours](/fr/optimize/feedback) pour plus d'informations sur l'utilisation des données de retour afin d'améliorer votre contenu.
|
|
|
|
<div id="filter-time-period">
|
|
## Filtrer par période
|
|
</div>
|
|
|
|
Utilisez le sélecteur de plage pour ajuster la période affichée pour les données.
|
|
|
|
<Frame>
|
|
<img
|
|
src="/images/analytics/range-selector-light.png"
|
|
alt="Le sélecteur de plage déployé pour afficher les options de visualisation des données sur différentes périodes."
|
|
className="block dark:hidden"
|
|
/>
|
|
|
|
<img
|
|
src="/images/analytics/range-selector-dark.png"
|
|
alt="Le sélecteur de plage déployé pour afficher les options de visualisation des données sur différentes périodes."
|
|
className="hidden dark:block"
|
|
/>
|
|
</Frame>
|
|
|
|
<div id="export-analytics">
|
|
## Exporter l'analytique
|
|
</div>
|
|
|
|
Exportez les catégories d'analytique au format CSV pour une analyse plus approfondie, des rapports ou l'archivage. Les exports respectent la plage de temps sélectionnée.
|
|
|
|
1. Cliquez sur **Export to CSV**.
|
|
2. Sélectionnez la catégorie à exporter : trafic, référents, conversations de l'assistant, recherches ou retours.
|
|
3. Mintlify vous envoie un e-mail contenant un lien de téléchargement lorsque l'export est prêt.
|
|
|
|
<Frame>
|
|
<img
|
|
src="/images/analytics/export-to-csv-light.png"
|
|
alt="Le bouton d'export vers CSV sur la page d'analytique."
|
|
className="block dark:hidden"
|
|
/>
|
|
|
|
<img
|
|
src="/images/analytics/export-to-csv-dark.png"
|
|
alt="Le bouton d'export vers CSV sur la page d'analytique."
|
|
className="hidden dark:block"
|
|
/>
|
|
</Frame>
|
|
|
|
<div id="traffic-exports">
|
|
### Exports de trafic
|
|
</div>
|
|
|
|
Les exports de trafic ventilent les pages vues par catégorie de visiteur pour que vous puissiez voir quelle part de votre trafic provient d'humains par rapport aux agents, aux robots d'indexation et aux autres bots.
|
|
|
|
| Colonne | Description |
|
|
| --- | --- |
|
|
| `humanViews` | Pages HTML vues par du trafic non issu de bots. |
|
|
| `aiViews` | Vues provenant d'agents IA tels que ChatGPT, Claude et Cursor, ainsi que les récupérations de pages Markdown par des clients qui ne sont pas des robots d'indexation reconnus. |
|
|
| `searchIndexViews` | Vues provenant des robots de recherche et d'indexation, tels que Googlebot, Bingbot et OAI-SearchBot. |
|
|
| `trainingViews` | Vues provenant des robots qui collectent du contenu pour l'entraînement de modèles d'IA, tels que GPTBot, ClaudeBot et CCBot. |
|
|
| `otherAiViews` | Vues provenant d'autres bots liés à l'IA qui ne correspondent pas aux catégories précédentes. |
|
|
| `totalViews` | La somme de `humanViews` et `aiViews`. |
|
|
|
|
Mintlify classe chaque vue à l'aide de motifs user-agent connus pour les robots de recherche, les robots d'entraînement et les assistants IA. Les catégories sont mutuellement exclusives, chaque vue ne compte donc que dans une seule colonne.
|
|
|
|
<Note>
|
|
`searchIndexViews`, `trainingViews` et `otherAiViews` ne sont pas comptabilisés dans `totalViews`.
|
|
</Note>
|
|
|
|
<div id="assistant-exports">
|
|
### Exports de l'assistant
|
|
</div>
|
|
|
|
Les exports de l'assistant incluent les requêtes, les réponses, les sources et une colonne `resolutionStatus` qui indique si l'assistant a répondu avec succès à chaque question (`answered` ou `unanswered`). Utilisez la colonne `resolutionStatus` pour identifier les lacunes de documentation révélées par les questions auxquelles l'assistant n'a pas pu répondre.
|
|
|
|
<Tip>
|
|
Exemples de prompts d'analyse pour les exports de l'assistant :
|
|
|
|
- Lister toutes les requêtes sans sources citées.
|
|
- Trouver des schémas dans les interactions infructueuses.
|
|
- Regrouper les requêtes sans réponse par sujet pour prioriser les mises à jour de contenu.
|
|
</Tip>
|
|
|
|
<div id="stream-analytics-events">
|
|
## Diffuser les événements d'analytique
|
|
</div>
|
|
|
|
<Info>
|
|
La diffusion des analytiques est disponible sur les [plans Enterprise](https://mintlify.com/pricing?ref=analytics-streaming).
|
|
</Info>
|
|
|
|
Diffusez les événements d'analytique vers Amazon S3 en quasi temps réel. Utilisez la diffusion pour envoyer des événements vers votre entrepôt de données ou vos pipelines d'analytique en aval sans attendre les exports CSV.
|
|
|
|
Les membres autorisés à mettre à jour les paramètres de l'organisation peuvent ajouter plusieurs destinations, choisir les catégories d'événements à envoyer et sélectionner les déploiements depuis lesquels diffuser. La diffusion des analytiques utilise un modèle d'inclusion : aucun événement n'est diffusé tant que vous n'avez pas sélectionné au moins une catégorie et au moins un déploiement. La même sélection de catégories et de déploiements s'applique à toutes les destinations.
|
|
|
|
<div id="add-a-destination">
|
|
### Ajouter une destination
|
|
</div>
|
|
|
|
1. Accédez à la page [Streaming](https://app.mintlify.com/settings/organization/streaming) de votre tableau de bord.
|
|
2. Dans la section **Analytics streaming**, sélectionnez **Configure**.
|
|
3. Sélectionnez **Add destination**.
|
|
4. Saisissez un libellé facultatif pour identifier la destination, puis fournissez les détails de connexion Amazon S3 : bucket, région AWS, ID de clé d'accès et clé d'accès secrète. Facultativement, saisissez un préfixe que Mintlify ajoutera au début de chaque clé d'objet.
|
|
5. Sélectionnez **Add destination**.
|
|
|
|
<Accordion title="Préparer les identifiants Amazon S3">
|
|
Créez un utilisateur IAM avec une clé d'accès dont la politique autorise l'écriture dans le bucket cible. Mintlify ne prend actuellement pas en charge l'endossement de rôle ni les identifiants temporaires nécessitant un jeton de session. Au minimum, accordez `s3:PutObject` sur le bucket et le préfixe de clé que vous prévoyez d'utiliser. Par exemple :
|
|
|
|
```json
|
|
{
|
|
"Version": "2012-10-17",
|
|
"Statement": [
|
|
{
|
|
"Effect": "Allow",
|
|
"Action": ["s3:PutObject"],
|
|
"Resource": "arn:aws:s3:::your-bucket-name/analytics/*"
|
|
}
|
|
]
|
|
}
|
|
```
|
|
|
|
Utilisez l'ID de clé d'accès et la clé d'accès secrète de cet utilisateur IAM lors de l'ajout de la destination. Le préfixe de clé est facultatif. Mintlify l'ajoute au début de chaque clé d'objet.
|
|
</Accordion>
|
|
|
|
Pour arrêter la diffusion vers une destination, ouvrez la configuration de diffusion et sélectionnez l'icône <Icon icon="trash-2" /> de suppression à côté de la destination.
|
|
|
|
<div id="select-streamed-categories">
|
|
### Sélectionner les catégories diffusées
|
|
</div>
|
|
|
|
1. Accédez à la page [Streaming](https://app.mintlify.com/settings/organization/streaming) de votre tableau de bord.
|
|
2. Dans la section **Analytics streaming**, sélectionnez **Configure**.
|
|
3. Sous **Streamed categories**, sélectionnez les catégories que vous souhaitez envoyer.
|
|
|
|
| Catégorie | Exemples |
|
|
| --- | --- |
|
|
| Page views | Événements de vue de page et de Markdown. |
|
|
| Navigation | Clics sur les éléments de navigation, clics sur les CTA de navigation et changements de version. |
|
|
| Search | Requêtes de recherche, clics sur les résultats, fermetures de recherche et comparaisons de recherche. |
|
|
| Page components | Interactions avec les blocs extensibles, accordéons, blocs de code et le playground de l'API. |
|
|
| Feedback | Pouces vers le haut, pouces vers le bas et envois de retours détaillés. |
|
|
| AI Assistant | Conversations de l'assistant, sources, suggestions, retours et erreurs. |
|
|
| Context menu & MCP | Actions du menu contextuel, copies de liens MCP, installations de serveurs MCP et appels d'outils MCP. |
|
|
|
|
Les exemples résument chaque catégorie. Utilisez la valeur `eventType` diffusée pour identifier l'événement exact.
|
|
|
|
4. Sélectionnez **Save changes**.
|
|
|
|
<div id="select-streamed-deployments">
|
|
### Sélectionner les déploiements diffusés
|
|
</div>
|
|
|
|
Choisissez les déploiements de votre organisation qui envoient des événements. Chaque déploiement est listé par sous-domaine. Sélectionner **All deployments** sélectionne tous les déploiements qui existent lorsque vous enregistrez la configuration. Si vous créez un autre déploiement ultérieurement, revenez à la configuration de diffusion et sélectionnez-le.
|
|
|
|
1. Accédez à la page [Streaming](https://app.mintlify.com/settings/organization/streaming) de votre tableau de bord.
|
|
2. Dans la section **Analytics streaming**, sélectionnez **Configure**.
|
|
3. Sous **Streamed deployments**, sélectionnez les déploiements depuis lesquels vous souhaitez envoyer des événements.
|
|
4. Sélectionnez **Save changes**.
|
|
|
|
Aucun événement n'est diffusé tant qu'au moins une catégorie et au moins un déploiement ne sont pas sélectionnés.
|
|
|
|
<div id="understand-streamed-data">
|
|
### Comprendre les données diffusées
|
|
</div>
|
|
|
|
Mintlify écrit des objets JSON délimités par des sauts de ligne (`.jsonl`) dans votre bucket. Les noms des objets sont générés à partir d'horodatages UTC. Si vous configurez un préfixe de clé, Mintlify écrit les objets sous ce préfixe.
|
|
|
|
Chaque ligne contient une enveloppe d'événement avec `eventType` et `payload`. `eventType` est le nom de l'événement, par exemple `docs.content.view`. `payload` contient l'événement d'analytique sous forme d'objet JSON ou de chaîne encodée en JSON. Si `payload` est une chaîne, analysez-la comme du JSON avant de la charger dans votre entrepôt de données.
|
|
|
|
<Accordion title="Exemple d'événement diffusé">
|
|
```json
|
|
{
|
|
"eventType": "docs.content.view",
|
|
"payload": {
|
|
"event_id": "4b91fdbc-4677-4e03-b51b-5f2da41c8654",
|
|
"subdomain": "docs",
|
|
"user_id": "",
|
|
"anon_id": "anon_01JZ8W6QKEJ6ECG1T7QK2S5PZ2",
|
|
"session_id": "session_01JZ8W8CS5JC8T18HXH8ES7Z5M",
|
|
"created_at": "2026-07-22T23:21:41.063Z",
|
|
"event": "docs.content.view",
|
|
"path": "/quickstart",
|
|
"referrer": "https://www.example.com/",
|
|
"user_agent": "Mozilla/5.0",
|
|
"ip": "203.0.113.10",
|
|
"properties": {}
|
|
}
|
|
}
|
|
```
|
|
</Accordion>
|
|
|
|
Le payload de l'événement contient les champs suivants :
|
|
|
|
| Champ | Description |
|
|
| --- | --- |
|
|
| `event_id` | UUID qui identifie l'événement. Utilisez-le comme clé de déduplication lors du chargement des données. |
|
|
| `subdomain` | Sous-domaine du déploiement qui a généré l'événement. |
|
|
| `user_id` | ID de l'utilisateur authentifié, lorsqu'il est disponible. |
|
|
| `anon_id` | ID du visiteur anonyme, lorsqu'il est disponible. |
|
|
| `session_id` | ID de la session du visiteur ou de l'assistant, lorsqu'il est disponible. |
|
|
| `created_at` | Horodatage ISO 8601 indiquant quand l'événement s'est produit. |
|
|
| `event` | Nom de l'événement. Il correspond à `eventType` dans l'enveloppe. |
|
|
| `path` | Chemin de la documentation où l'événement s'est produit. |
|
|
| `referrer` | URL de référence, lorsqu'elle est disponible. |
|
|
| `user_agent` | Chaîne user-agent du navigateur ou du client. |
|
|
| `ip` | Adresse IP du visiteur. |
|
|
| `properties` | Données propres à l'événement sous forme d'objet JSON ou de chaîne encodée en JSON. |
|
|
|
|
Les modifications de configuration peuvent prendre jusqu'à une minute pour s'appliquer.
|
|
|
|
<Warning>
|
|
Les événements diffusés peuvent contenir des données personnelles, notamment des adresses IP, des identifiants d'utilisateur et de session, des requêtes et réponses de l'assistant, ainsi que des commentaires ou coordonnées envoyés dans les retours. Appliquez les contrôles d'accès, les politiques de conservation et les autres exigences de traitement des données appropriés à votre organisation.
|
|
</Warning>
|