> ## Documentation Index
> Fetch the complete documentation index at: https://adminroletesting-justin-client-exports.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
# Obtener conversaciones del assistant
> Devuelve el historial paginado de conversaciones del Asistente de IA
## Uso
Utiliza este endpoint para exportar el historial de conversaciones del Asistente de IA desde tu documentación. Cada conversación incluye la búsqueda del usuario, la respuesta del Asistente de IA, las fuentes citadas, el estado de resolución y la categoría de la búsqueda.
Pagina los resultados usando el parámetro `cursor` devuelto en la respuesta. Continúa obteniendo resultados mientras `hasMore` sea `true`.
## Filtrado
Filtra conversaciones por intervalo de fechas usando los parámetros `dateFrom` y `dateTo`.
## Datos de conversación
Cada conversación incluye:
* **query**: La pregunta del usuario
* **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)
* **pageUrl**: URL completa de la página de documentación donde se inició la conversación, o `null` si no hay ninguna ruta de página disponible. Usa este campo para atribuir conversaciones a una página específica.
## OpenAPI
````yaml es/analytics.openapi.json GET /v1/analytics/{projectId}/assistant
openapi: 3.1.0
info:
title: Mintlify Analytics Export API
version: 1.0.0
description: API para exportar datos de Analytics de la documentación
servers:
- url: https://api.mintlify.com
description: Producción
security: []
paths:
/v1/analytics/{projectId}/assistant:
get:
tags:
- Analytics
summary: Obtener conversaciones del assistant
description: Devuelve el historial paginado de conversaciones del Asistente de IA
parameters:
- $ref: '#/components/parameters/projectId'
- schema:
type: string
description: Fecha en formato ISO 8601 o AAAA-MM-DD
example: '2024-01-01'
required: false
name: dateFrom
in: query
- schema:
type: string
description: >-
Fecha en formato ISO 8601 o AAAA-MM-DD. `dateTo` es un límite
superior exclusivo. Los resultados incluyen fechas anteriores,
pero no la fecha especificada.
example: '2024-01-01'
required: false
name: dateTo
in: query
- schema:
type: number
minimum: 1
maximum: 1000
default: 100
description: Número máximo de resultados por página
required: false
name: limit
in: query
- schema:
type: string
format: ulid
description: Cursor de paginación (formato ULID)
required: false
name: cursor
in: query
responses:
'200':
description: Datos de conversación paginados
content:
application/json:
schema:
$ref: '#/components/schemas/AssistantConversationsResponse'
'400':
description: Parámetros de búsqueda no válidos
content:
application/json:
schema:
$ref: '#/components/schemas/AnalyticsErrorResponse'
'500':
description: Error del servidor
content:
application/json:
schema:
$ref: '#/components/schemas/AnalyticsErrorResponse'
security:
- bearerAuth: []
components:
parameters:
projectId:
schema:
$ref: '#/components/schemas/projectId'
required: true
name: projectId
in: path
schemas:
AssistantConversationsResponse:
type: object
properties:
conversations:
type: array
description: Lista de conversaciones del assistant.
items:
type: object
properties:
id:
type: string
description: Identificador único de la conversación.
timestamp:
type: string
description: Marca de tiempo en la que se produjo la conversación.
query:
type: string
description: La pregunta del usuario para el assistant.
response:
type: string
description: La respuesta del assistant.
sources:
type: array
description: Páginas de la documentación mencionadas en la respuesta.
items:
type: object
properties:
title:
type: string
description: Título de la página de documentación mencionada.
url:
type: string
description: URL de la página de documentación mencionada.
required:
- title
- url
queryCategory:
type:
- string
- '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:
- id
- timestamp
- query
- response
- sources
- queryCategory
- pageUrl
nextCursor:
type:
- string
- 'null'
description: >-
Cursor para obtener la siguiente página de resultados. Es nulo si no
hay más resultados.
hasMore:
type: boolean
description: Indica si hay resultados adicionales más allá de esta página.
required:
- conversations
- nextCursor
- hasMore
AnalyticsErrorResponse:
type: object
properties:
error:
type: string
description: Mensaje de error que describe lo que salió mal.
details:
type: array
description: Detalles adicionales del error.
items:
type: object
properties:
message:
type: string
description: >-
Descripción de un error específico de validación o
procesamiento.
required:
- message
required:
- error
projectId:
type: string
description: >-
Tu ID de proyecto. Puedes copiarlo desde la página [API
keys](https://dashboard.mintlify.com/settings/organization/api-keys) en
tu dashboard.
securitySchemes:
bearerAuth:
type: http
scheme: bearer
description: >-
El encabezado Authorization requiere un token Bearer. Usa una clave de
API de administrador (con el prefijo `mint_`). Esta es una clave secreta
del lado del servidor. Genérala en la [página de claves de
API](https://dashboard.mintlify.com/settings/organization/api-keys) de
tu dashboard.
````