Obtener conversaciones del assistant

Obtén el historial de conversaciones del Asistente de IA, incluidas las consultas, respuestas, fuentes citadas y categorías.

GET /v1/analytics/{projectId}/assistant

Obtener conversaciones del assistant

cURL

curl --request GET \
  --url https://api.mintlify.com/v1/analytics/{projectId}/assistant \
  --header 'Authorization: Bearer <token>'

200

{
  "conversations": [
    {
      "id": "<string>",
      "timestamp": "<string>",
      "query": "<string>",
      "response": "<string>",
      "sources": [
        {
          "title": "<string>",
          "url": "<string>"
        }
      ],
      "queryCategory": "<string>"
    }
  ],
  "nextCursor": "<string>",
  "hasMore": true
}

​

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 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
• queryCategory: Clasificación del tipo de búsqueda (si está disponible)

Autorizaciones

Authorization · string · header · requerido

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 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

200

application/json

Datos de conversación paginados

conversations · object[] · requerido

Lista de conversaciones del assistant.

Show child attributes

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.