Skip to main content
GET
Obtener conversaciones del assistant

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 fila representa un turno del usuario en una conversación. Una conversación con varios intercambios genera varias filas que comparten el mismo conversationId. Cada fila incluye:
  • query: La pregunta del usuario.
  • response: La respuesta del assistant. En los turnos de pregunta aclaratoria, es la pregunta de seguimiento que el assistant le hizo al usuario.
  • responseType: answer o clarifying_question. clarifying_question indica que el assistant hizo una pregunta de seguimiento en lugar de responder. Su valor predeterminado es answer cuando no está presente.
  • 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 este turno. Puede ser answered o unanswered. Se calcula por fila, por lo que una misma conversación puede contener ambos estados. 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.
  • timestamp: Cuándo el usuario envió el mensaje que inició este turno. Las filas de la misma conversación tienen marcas de tiempo distintas.
  • 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.

Límites de uso

Este endpoint permite 100 solicitudes por organización por hora. Todos los endpoints de analytics comparten este límite.

Autorizaciones

Authorization
string
header
requerido

El encabezado Authorization requiere un token de tipo Bearer. Usa una clave de API de administrador. Esta es una clave secreta del lado del servidor. Genera una en la página de claves de API de tu dashboard.

Parámetros de ruta

projectId
string
requerido

Tu ID de proyecto. Puedes copiarlo desde la página API keys en tu dashboard.

Parámetros de consulta

dateFrom
string

Fecha en formato ISO 8601 o AAAA-MM-DD

Ejemplo:

"2024-01-01"

dateTo
string

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.

Ejemplo:

"2024-01-01"

limit
number
predeterminado:100

Número máximo de resultados por página

Rango requerido: 1 <= x <= 1000
cursor
string<ulid>

Cursor de paginación (formato ULID)

Respuesta

Datos de conversación paginados

conversations
object[]
requerido

Lista de conversaciones del assistant.

nextCursor
string | null
requerido

Cursor para obtener la siguiente página de resultados. Es nulo si no hay más resultados.

hasMore
boolean
requerido

Indica si hay resultados adicionales más allá de esta página.