Skip to content

Commit 76b0d76

Browse files
docs: document pageUrl field in assistant conversations export API (#6168)
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
1 parent 2755d3c commit 76b0d76

8 files changed

Lines changed: 43 additions & 7 deletions

File tree

analytics.openapi.json

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -343,6 +343,13 @@
343343
"null"
344344
],
345345
"description": "Auto-assigned category grouping for the conversation, if applicable."
346+
},
347+
"pageUrl": {
348+
"type": [
349+
"string",
350+
"null"
351+
],
352+
"description": "Full URL of the documentation page where the conversation started. Null if no page path was captured."
346353
}
347354
},
348355
"required": [
@@ -352,7 +359,8 @@
352359
"response",
353360
"sources",
354361
"resolutionStatus",
355-
"queryCategory"
362+
"queryCategory",
363+
"pageUrl"
356364
]
357365
}
358366
},

api/analytics/assistant-conversations.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,3 +23,4 @@ Each conversation includes:
2323
- **sources**: Pages referenced in the response, with title and URL
2424
- **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.
2525
- **queryCategory**: Classification of the query type (if available)
26+
- **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.

es/analytics.openapi.json

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -362,6 +362,13 @@
362362
"null"
363363
],
364364
"description": "Categoría de agrupación asignada automáticamente a la conversación, si corresponde."
365+
},
366+
"pageUrl": {
367+
"type": [
368+
"string",
369+
"null"
370+
],
371+
"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."
365372
}
366373
},
367374
"required": [
@@ -370,7 +377,8 @@
370377
"query",
371378
"response",
372379
"sources",
373-
"queryCategory"
380+
"queryCategory",
381+
"pageUrl"
374382
]
375383
}
376384
},

es/api/analytics/assistant-conversations.mdx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,4 +28,5 @@ Cada conversación incluye:
2828
- **response**: La respuesta del assistant
2929
- **sources**: Páginas a las que se hace referencia en la respuesta, con título y URL
3030
- **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.
31-
- **queryCategory**: Clasificación del tipo de búsqueda (si está disponible)
31+
- **queryCategory**: Clasificación del tipo de búsqueda (si está disponible)
32+
- **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.

fr/analytics.openapi.json

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -362,6 +362,13 @@
362362
"null"
363363
],
364364
"description": "Catégorie de regroupement automatiquement attribuée à la conversation, le cas échéant."
365+
},
366+
"pageUrl": {
367+
"type": [
368+
"string",
369+
"null"
370+
],
371+
"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é."
365372
}
366373
},
367374
"required": [
@@ -370,7 +377,8 @@
370377
"query",
371378
"response",
372379
"sources",
373-
"queryCategory"
380+
"queryCategory",
381+
"pageUrl"
374382
]
375383
}
376384
},

fr/api/analytics/assistant-conversations.mdx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,4 +28,5 @@ Chaque conversation comprend :
2828
- **response** : la réponse de l’Assistant
2929
- **sources** : les pages référencées dans la réponse, avec leur title et leur URL
3030
- **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.
31-
- **queryCategory** : la classification du type de requête (si disponible)
31+
- **queryCategory** : la classification du type de requête (si disponible)
32+
- **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.

zh/analytics.openapi.json

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -362,6 +362,13 @@
362362
"null"
363363
],
364364
"description": "会话自动分配的分类分组(如适用)。"
365+
},
366+
"pageUrl": {
367+
"type": [
368+
"string",
369+
"null"
370+
],
371+
"description": "会话开始时所在文档页面的完整 URL。如果没有捕获页面路径,则为 null。"
365372
}
366373
},
367374
"required": [
@@ -370,7 +377,8 @@
370377
"query",
371378
"response",
372379
"sources",
373-
"queryCategory"
380+
"queryCategory",
381+
"pageUrl"
374382
]
375383
}
376384
},

zh/api/analytics/assistant-conversations.mdx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,4 +28,5 @@ keywords: [ "analytics", "assistant", "conversations", "export", "AI" ]
2828
- **response**: AI 助手的回答
2929
- **sources**: 回答中引用的页面,包括标题和 URL
3030
- **resolutionStatus**: AI 助手是否成功回答了问题。值为 `answered``unanswered`。使用此字段可跟踪并分析 AI 助手无法解答的用户问题所暴露出的文档缺口。
31-
- **queryCategory**: query 的类型分类(如果可用)
31+
- **queryCategory**: query 的类型分类(如果可用)
32+
- **pageUrl**: 会话开始时所在文档页面的完整 URL;如果未捕获页面路径,则为 `null`。使用此字段可将会话归因到具体页面。

0 commit comments

Comments
 (0)