From 41bde9af67f8e9ce63dcacca9bf99f8322dae223 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Sat, 13 Jun 2026 15:11:30 +0000 Subject: [PATCH] docs: document pageUrl field in assistant conversations export API --- analytics.openapi.json | 10 +++++++++- api/analytics/assistant-conversations.mdx | 1 + es/analytics.openapi.json | 10 +++++++++- es/api/analytics/assistant-conversations.mdx | 3 ++- fr/analytics.openapi.json | 10 +++++++++- fr/api/analytics/assistant-conversations.mdx | 3 ++- zh/analytics.openapi.json | 10 +++++++++- zh/api/analytics/assistant-conversations.mdx | 3 ++- 8 files changed, 43 insertions(+), 7 deletions(-) diff --git a/analytics.openapi.json b/analytics.openapi.json index f1ecea56fe..b8b345fbd3 100644 --- a/analytics.openapi.json +++ b/analytics.openapi.json @@ -343,6 +343,13 @@ "null" ], "description": "Auto-assigned category grouping for the conversation, if applicable." + }, + "pageUrl": { + "type": [ + "string", + "null" + ], + "description": "Full URL of the documentation page where the conversation started. Null if no page path was captured." } }, "required": [ @@ -352,7 +359,8 @@ "response", "sources", "resolutionStatus", - "queryCategory" + "queryCategory", + "pageUrl" ] } }, diff --git a/api/analytics/assistant-conversations.mdx b/api/analytics/assistant-conversations.mdx index 14c33ae961..f697e68557 100644 --- a/api/analytics/assistant-conversations.mdx +++ b/api/analytics/assistant-conversations.mdx @@ -23,3 +23,4 @@ Each conversation includes: - **sources**: Pages referenced in the response, with title and URL - **resolutionStatus**: Whether the assistant successfully answered the question. Either `answered` or `unanswered`. Use this field to track and analyze documentation gaps surfaced by user questions the assistant could not resolve. - **queryCategory**: Classification of the query type (if available) +- **pageUrl**: Full URL of the documentation page where the conversation started, or `null` if no page path was captured. Use this field to attribute conversations to a specific page. diff --git a/es/analytics.openapi.json b/es/analytics.openapi.json index ccb485c2b1..baeafe97e0 100644 --- a/es/analytics.openapi.json +++ b/es/analytics.openapi.json @@ -362,6 +362,13 @@ "null" ], "description": "Categoría de agrupación asignada automáticamente a la conversación, si corresponde." + }, + "pageUrl": { + "type": [ + "string", + "null" + ], + "description": "URL completa de la página de documentación donde se inició la conversación. Es null si no se capturó ninguna ruta de página." } }, "required": [ @@ -370,7 +377,8 @@ "query", "response", "sources", - "queryCategory" + "queryCategory", + "pageUrl" ] } }, diff --git a/es/api/analytics/assistant-conversations.mdx b/es/api/analytics/assistant-conversations.mdx index 7814b7d72e..f37b8904e2 100644 --- a/es/api/analytics/assistant-conversations.mdx +++ b/es/api/analytics/assistant-conversations.mdx @@ -28,4 +28,5 @@ Cada conversación incluye: - **response**: La respuesta del assistant - **sources**: Páginas a las que se hace referencia en la respuesta, con título y URL - **resolutionStatus**: Indica si el assistant respondió correctamente a la pregunta. Puede ser `answered` o `unanswered`. Usa este campo para identificar y analizar lagunas en la documentación detectadas a partir de preguntas de usuarios que el assistant no pudo resolver. -- **queryCategory**: Clasificación del tipo de búsqueda (si está disponible) \ No newline at end of file +- **queryCategory**: Clasificación del tipo de búsqueda (si está disponible) +- **pageUrl**: URL completa de la página de documentación donde se inició la conversación, o `null` si no se capturó ninguna ruta de página. Usa este campo para atribuir conversaciones a una página específica. \ No newline at end of file diff --git a/fr/analytics.openapi.json b/fr/analytics.openapi.json index e2c3062a3c..bb7cece6f5 100644 --- a/fr/analytics.openapi.json +++ b/fr/analytics.openapi.json @@ -362,6 +362,13 @@ "null" ], "description": "Catégorie de regroupement automatiquement attribuée à la conversation, le cas échéant." + }, + "pageUrl": { + "type": [ + "string", + "null" + ], + "description": "URL complète de la page de documentation où la conversation a démarré. Null si aucun chemin de page n'a été capturé." } }, "required": [ @@ -370,7 +377,8 @@ "query", "response", "sources", - "queryCategory" + "queryCategory", + "pageUrl" ] } }, diff --git a/fr/api/analytics/assistant-conversations.mdx b/fr/api/analytics/assistant-conversations.mdx index 08658ec412..e4efc1476d 100644 --- a/fr/api/analytics/assistant-conversations.mdx +++ b/fr/api/analytics/assistant-conversations.mdx @@ -28,4 +28,5 @@ Chaque conversation comprend : - **response** : la réponse de l’Assistant - **sources** : les pages référencées dans la réponse, avec leur title et leur URL - **resolutionStatus** : indique si l’Assistant a répondu correctement à la question. La valeur est `answered` ou `unanswered`. Utilisez ce champ pour suivre et analyser les lacunes de la documentation mises en évidence par les questions des utilisateurs auxquelles l’Assistant n’a pas pu répondre. -- **queryCategory** : la classification du type de requête (si disponible) \ No newline at end of file +- **queryCategory** : la classification du type de requête (si disponible) +- **pageUrl** : URL complète de la page de documentation où la conversation a démarré, ou `null` si aucun chemin de page n'a été capturé. Utilisez ce champ pour attribuer les conversations à une page spécifique. \ No newline at end of file diff --git a/zh/analytics.openapi.json b/zh/analytics.openapi.json index ce41973290..26d77cd2e0 100644 --- a/zh/analytics.openapi.json +++ b/zh/analytics.openapi.json @@ -362,6 +362,13 @@ "null" ], "description": "会话自动分配的分类分组（如适用）。" + }, + "pageUrl": { + "type": [ + "string", + "null" + ], + "description": "会话开始时所在文档页面的完整 URL。如果没有捕获页面路径，则为 null。" } }, "required": [ @@ -370,7 +377,8 @@ "query", "response", "sources", - "queryCategory" + "queryCategory", + "pageUrl" ] } }, diff --git a/zh/api/analytics/assistant-conversations.mdx b/zh/api/analytics/assistant-conversations.mdx index 2bd5808dbe..b135c4a0c0 100644 --- a/zh/api/analytics/assistant-conversations.mdx +++ b/zh/api/analytics/assistant-conversations.mdx @@ -28,4 +28,5 @@ keywords: [ "analytics", "assistant", "conversations", "export", "AI" ] - **response**: AI 助手的回答 - **sources**: 回答中引用的页面，包括标题和 URL - **resolutionStatus**: AI 助手是否成功回答了问题。值为 `answered` 或 `unanswered`。使用此字段可跟踪并分析 AI 助手无法解答的用户问题所暴露出的文档缺口。 -- **queryCategory**: query 的类型分类（如果可用） \ No newline at end of file +- **queryCategory**: query 的类型分类（如果可用） +- **pageUrl**: 会话开始时所在文档页面的完整 URL；如果未捕获页面路径，则为 `null`。使用此字段可将会话归因到具体页面。 \ No newline at end of file