# Export des Conversations

Il est possible d'exporter les conversations dans plusieurs formats (XML, CSV, Excel) et selon plusieurs critères.

L'API d'export est disponible à l'URL suivante : https\://**urlbackoffice**.doyoudreamup.com/servlet/dialogexport

Important : n'oubliez pas de remplacer **urlbackoffice** par l'URL de votre plateforme.

Deux moyens sont mis à disposition pour exporter des conversations :

* Toutes les conversations entre 2 dates ;
* Une seule conversation par son identifiant.

Le service peut être utilisé via HTTP GET ou HTTP POST.

Note : les exports Excel sont limités à une période de 95 jours. Une requête effectuée au-delà de cette période entraînera une erreur.

### Paramètres du service

**Paramètres pour exporter des conversations entre 2 dates**

| Paramètre       | Description                                                                                                                         |             |
| --------------- | ----------------------------------------------------------------------------------------------------------------------------------- | ----------- |
| botId           | Identifiant du bot (UUID) Accessible par l'interface depuis **Préférences > APIs** puis en bas de page                              | obligatoire |
| language        | Langues de dialogue Valeurs autorisées : fr, en, nl                                                                                 | obligatoire |
| startDate       | Date de début des formats d'exportation autorisés : aaaa-MM-jj ou aaaa-MM-jj HH : mm: ss s                                          | obligatoire |
| endDate         | Date de fin de l'export. Les formats autorisés sont les mêmes que pour la date de début.                                            | obligatoire |
| formats         | Format de sortie Valeurs autorisées : Xml (default), CSV, Excel                                                                     |             |
| exportDialogIds | Permet de stocker ou non les ID de dialogue. Valeurs autorisées : true (stocke l'ID), false (valeur par défaut, ne stocke pas l'ID) |             |

**Paramètres pour exporter une conversation à partir de son identifiant**

| Paramètre       | Description                                                                                                                         |             |
| --------------- | ----------------------------------------------------------------------------------------------------------------------------------- | ----------- |
| botId           | Identifiant du bot (UUID) Accessible par l'interface depuis **Préférences > APIs** puis en bas de page.                             | obligatoire |
| language        | Langues de dialogue Valeurs autorisées : fr, en, nl                                                                                 | obligatoire |
| contextId       | ID du dialogue Cet ID est fourni par Do You Dream Up                                                                                | obligatoire |
| formats         | Format de sortie Valeurs autorisées : Xml (default), CSV, Excel                                                                     |             |
| exportDialogIds | Permet de stocker ou non les ID de dialogue. Valeurs autorisées : true (stocke l'ID), false (valeur par défaut, ne stocke pas l'ID) |             |

### Retour XML

Dans le cas d'un export entre 2 dates, les conversations sont exportées dans plusieurs fichiers XML - un par jour de la période choisie - qui sont compressés dans un fichier au format zip.

Dans le cas d'un export d'une seule conversation, le fichier XML n'est pas compressé.

Ci-dessous la description des champs du format XML :

```
<dialogsExport>
            <dialog>
            <length>...</length>
            <businessLength>...</businessLength>
            <userIdentification>...</userIdentification>
             <userLocation>...</userLocation>
            <browser>...</browser>
            <os>...</os>
            <serverName>...</serverName><livechatType\>...</livechatType\>
            <interactions>
            <interaction>
            <userTalk>...</userTalk>
            <userUrl>...</userUrl>
            <interactionExternValuesString>...</interactionExternValuesString>
            <botAnswer>...</botAnswer>
            <date>...</date>
            <tags><tag>...</tag></tags>
            <date>...</date>
            <typeResponse>...</typeResponse>
            <matches><InteractionMatch>
            <actionId>...</actionId>
            <score>...</score>
            <scoreMatch>...</scoreMatch>
             </InteractionMatch>...</matches>
            <businessInteraction>...</businessInteraction>
            <durationRuntime>...</durationRuntime>
            <language>...</language>
            <solutionUsed>
            <value>...</value>
            <name>...</name>
            <compatibleSolution>...</compatibleSolution></solutionUsed>
            <encrypted>...</encrypted>
             </interaction>...</interactions>

            <externValues>
            <externValue>
            <name>...</name>
            <value>...</value>
             </externValue>...</externValues>
            <startDate>...</startDate>
            <testDialog>...</testDialog>
           <dialogType>...</dialogType>
            <consultationSpace id="...">...
             </consultationSpace>
            <alreadyCame>...</alreadyCame>

            <qualificationMode>...</qualificationMode>
             </dialog>...</dialogsExport>
             
```

<figure><img src="https://1101559743-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FgMQl4578l4DzuAEhrEii%2Fuploads%2FejstMYhp4wRvzrI4F1s6%2Fimage.png?alt=media&#x26;token=215fbe36-3b6e-4bab-b99b-3b1ea65e9b72" alt=""><figcaption></figcaption></figure>

### Retour CSV

Tout comme pour l'export XML, l'export CSV fournit un fichier compressé au format zip comprenant un fichier CSV par jour lorsqu'il s'agit d'un export entre 2 dates.

Dans le cas d'un export d'une seule conversation, le fichier CSV n'est pas compressé.

Les colonnes sont séparées par des point-virgules.

| **Paramètres** |                                                                                 |
| -------------- | ------------------------------------------------------------------------------- |
| Date           | Date de début de la conversation                                                |
| Space          | L'endroit où la conversation a eu lieu                                          |
| Longueur       | Nombre d'interactions total                                                     |
| Qualification  | Indique si la conversation a été réussie ou est en échec- **OnlyDirectMatches** |

Toutes les questions de l'utilisateur ont abouti à une réponse directe du bot.

Cette typologie indique que la conversation est totalement réussie

* **EndingWithDirectMatch**

Des questions de l'utilisateur au cours de la conversation ont pu aboutir sur une reformulation ou une phrase incomprise, mais la dernière question a été comprise par le bot.

Cette typologie indique que la conversation a été réussie car l'internaute a obtenu une réponse à sa dernière question.

* **Failed**

La dernière question de l'utilisateur n'a pas été comprise ou abouti à une reformulation, même si d'autres questions au cours de la conversation ont été comprises.

Cette typologie indique que la conversation est en échec.

| **Paramètres**                               |                                                                                                                                                     |
| -------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
| dialog\_user\_id                             | ID utilisateur s'il a été renseigné                                                                                                                 |
| dialog\_nb\_rewords                          | Nombre de reformulations qui ont été proposées au cours de la conversation                                                                          |
| dialog\_nb\_garbages                         | Nombre de phrases mal comprises au cours de la conversation                                                                                         |
| dialog\_nb\_clicked\_automatic\_rewords      | Nombre de reformulations qui ont été proposées au cours de la conversation                                                                          |
| dialog\_nb\_clicked\_knowledge\_redirections | Lorsqu'une réponse du bot contient un lien vers une autre connaissance, le clic est comptabilisé dans cette variable                                |
| dialog\_context\_id                          | ID de la conversation                                                                                                                               |
| dialog\_user\_question                       | Dernière question de la conversation                                                                                                                |
| Thématiques                                  | Liste des thèmes utilisés au cours de la conversation. Celles-ci sont séparées par des point-virgules et donc apparaissent dans plusieurs colonnes. |

### Retour Excel

L'export Excel limite le nombre de conversations à 1000. Si davantage de conversations sont concernées par la période considérée, seules les 1000 premières apparaîtront dans le document exporté.

Chaque conversation est exportée dans le format suivant :

* Date de début (dd/MM/yyyy HH: mm: ss) ;
* Espace : espace ;
* Première interaction : question internaute ;
* Réponse du bot ;
* Date au format dd/MM/yyyy HH:mm:ss ;
* Qualification ;
* Satisfaction : positive ou négative. La satisfaction n'est pas systématiquement renseignée ;
* Raison d'insatisfaction : il s'agit d'une des trois raisons configurées dans le back office. La raison d'insatisfaction n'est pas systématiquement renseignée ;
* Commentaire d'insatisfaction : si l'utilisateur a laissé un commentaire d'insatisfaction ;
* Deuxième question internaute ;
* Deuxième réponse bot ;
* Date ;
* Qualification ;
* Satisfaction ;
* Raison d'insatisfaction ;
* Commentaire d'insatisfaction, etc.

La qualification indique le degré de compréhension de la question par le bot.

Le préfixe DM signifie *Direct Match* et indique que la question a été comprise.

Le préfixe RW signifie *Reword* et indique une reformulation.

La préfixe GB signifie *Garbage* et indique que la phrase n'a pas été comprise.

Le préfixe OP signifie *Opérateur* et indique que la réponse provient d'un opérateur humain.

Le préfixe ERR signifie *Error* et indique qu'il y a eu une erreur lors du traitement de la question.

| Paramètres                      |                                                                                                                                                              |
| ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| DMUnderstoodQuestion            | La question a été comprise par le bot et une réponse a été donnée                                                                                            |
| DMDisabledKnowledge             | La question a été comprise par le bot mais la connaissance n'est pas publiée, le bot a donc répondu qu'il n'était pas en mesure de répondre à cette question |
| DMClickRedirectionLink          | L'utilisateur a cliqué sur une URL présente dans la réponse précédente du bot                                                                                |
| DMPushReplace                   | La réponse qui a été apportée par le bot a été complètement modifiée par une réponse complémentaire                                                          |
| DMRewordClicked                 | L'utilisateur a cliqué sur un lien de la réponse précédente de le bot et ce lien dirigeait vers une réponse d'une autre connaissance                         |
| DMRewordClickedAuto             | L'utilisateur a cliqué sur un lien de reformulation de la réponse précédente du bot                                                                          |
| DMClickJavascriptLink           | L'utilisateur a cliqué sur un lien de la réponse précédente du bot qui effectue un appel javascript                                                          |
| RWOneReword                     | Reformulation avec une suggestion                                                                                                                            |
| RWTwoRewords                    | Reformulation avec deux suggestions                                                                                                                          |
| RWThreeRewords                  | Reformulation avec trois suggestions                                                                                                                         |
| GBMisunderstoodQuestion         | La question de l'utilisateur a été mal comprise                                                                                                              |
| GBTooManyMisunderstoodQuestions | La question de l'utilisateur a été mal comprise, mais au moins 2 autres questions de la boîte de dialogue n'avaient pas été comprises au préalable           |
| ERRApplicationException         | Une erreur d'application s'est produite                                                                                                                      |
| ERRAPIException                 | Une erreur lors d'un appel à un service Web externe s'est produit                                                                                            |
| OPWaitingForOperator            | Une remontée vers Livechat a été faite, le bot indique à l'utilisateur qu'il faut attendre la connexion d'un opérateur                                       |
| OPRegularOperatorAnswer         | Cette réponse vient d'un opérateur humain                                                                                                                    |