Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion analytics.openapi.json
Original file line number Diff line number Diff line change
Expand Up @@ -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": [
Expand All @@ -352,7 +359,8 @@
"response",
"sources",
"resolutionStatus",
"queryCategory"
"queryCategory",
"pageUrl"
]
}
},
Expand Down
1 change: 1 addition & 0 deletions api/analytics/assistant-conversations.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Get assistant conversations"
openapi: /analytics.openapi.json GET /v1/analytics/{projectId}/assistant

Check warning on line 3 in api/analytics/assistant-conversations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/analytics/assistant-conversations.mdx#L3

Use 'JSON' instead of 'json'.
keywords: ["analytics", "assistant", "conversations", "export", "AI"]

---
Expand All @@ -21,5 +21,6 @@
- **query**: The user's question
- **response**: The assistant's answer
- **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.

Check warning on line 24 in api/analytics/assistant-conversations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/analytics/assistant-conversations.mdx#L24

Did you really mean 'resolutionStatus'?
- **queryCategory**: Classification of the query type (if available)

Check warning on line 25 in api/analytics/assistant-conversations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/analytics/assistant-conversations.mdx#L25

Did you really mean 'queryCategory'?
- **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.

Check warning on line 26 in api/analytics/assistant-conversations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/analytics/assistant-conversations.mdx#L26

Did you really mean 'pageUrl'?

Check warning on line 26 in api/analytics/assistant-conversations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/analytics/assistant-conversations.mdx#L26

In general, use active voice instead of passive voice ('was captured').
10 changes: 9 additions & 1 deletion es/analytics.openapi.json
Original file line number Diff line number Diff line change
Expand Up @@ -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": [
Expand All @@ -370,7 +377,8 @@
"query",
"response",
"sources",
"queryCategory"
"queryCategory",
"pageUrl"
]
}
},
Expand Down
3 changes: 2 additions & 1 deletion es/api/analytics/assistant-conversations.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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)
- **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.
10 changes: 9 additions & 1 deletion fr/analytics.openapi.json
Original file line number Diff line number Diff line change
Expand Up @@ -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": [
Expand All @@ -370,7 +377,8 @@
"query",
"response",
"sources",
"queryCategory"
"queryCategory",
"pageUrl"
]
}
},
Expand Down
3 changes: 2 additions & 1 deletion fr/api/analytics/assistant-conversations.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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)
- **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.
10 changes: 9 additions & 1 deletion zh/analytics.openapi.json
Original file line number Diff line number Diff line change
Expand Up @@ -362,6 +362,13 @@
"null"
],
"description": "会话自动分配的分类分组(如适用)。"
},
"pageUrl": {
"type": [
"string",
"null"
],
"description": "会话开始时所在文档页面的完整 URL。如果没有捕获页面路径,则为 null。"
}
},
"required": [
Expand All @@ -370,7 +377,8 @@
"query",
"response",
"sources",
"queryCategory"
"queryCategory",
"pageUrl"
]
}
},
Expand Down
3 changes: 2 additions & 1 deletion zh/api/analytics/assistant-conversations.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,5 @@ keywords: [ "analytics", "assistant", "conversations", "export", "AI" ]
- **response**: AI 助手的回答
- **sources**: 回答中引用的页面,包括标题和 URL
- **resolutionStatus**: AI 助手是否成功回答了问题。值为 `answered``unanswered`。使用此字段可跟踪并分析 AI 助手无法解答的用户问题所暴露出的文档缺口。
- **queryCategory**: query 的类型分类(如果可用)
- **queryCategory**: query 的类型分类(如果可用)
- **pageUrl**: 会话开始时所在文档页面的完整 URL;如果未捕获页面路径,则为 `null`。使用此字段可将会话归因到具体页面。
Loading