Documentación API

Reportes Avanzados

Endpoints para obtener métricas, estadísticas y análisis del uso de la plataforma.

GET /api/reportes-avanzados/

Obtiene un resumen general de métricas del cliente.

GET /api/reportes-avanzados/

Headers

Authorization: Bearer JWT_TOKEN

Ejemplos

curl -X GET https://api-docmind.devol.es/api/reportes-avanzados/ \
  -H "Authorization: Bearer JWT_TOKEN"

Respuesta

{"total_extracciones": 1500, "completadas": 1200, "en_proceso": 50, "errores": 30, "tasa_completado": 80.0}

Resumen general con totales y tasas.

Errores

401Unauthorized

Token inválido.

{"msg": "Token inválido"}

GET /api/reportes-avanzados/time-range

Obtiene métricas filtradas por rango temporal.

GET /api/reportes-avanzados/time-range

Headers

Authorization: Bearer JWT_TOKEN

Query Parameters

  • start_date: (obligatorio) Fecha inicio YYYY-MM-DD
  • end_date: (obligatorio) Fecha fin YYYY-MM-DD
  • granularity: (opcional) Granularidad: dia, semana, mes. Por defecto: dia

Ejemplos

curl -X GET "https://api-docmind.devol.es/api/reportes-avanzados/time-range?start_date=2025-01-01&end_date=2025-06-30&granularity=mes" \
  -H "Authorization: Bearer JWT_TOKEN"

Respuesta

{"data": [{"periodo": "2025-01", "total": 200, "completadas": 180, "errores": 5}]}

Datos agrupados por período según la granularidad seleccionada.

Errores

400Bad Request

Fechas inválidas.

{"error": "Formato de fecha inválido"}

GET /api/reportes-avanzados/usuarios

Métricas de actividad por usuario.

GET /api/reportes-avanzados/usuarios

Headers

Authorization: Bearer JWT_TOKEN

Ejemplos

curl -X GET https://api-docmind.devol.es/api/reportes-avanzados/usuarios \
  -H "Authorization: Bearer JWT_TOKEN"

Respuesta

{"usuarios": [{"nombre": "Juan", "email": "juan@ej.com", "extracciones": 150, "ultima_actividad": "..."}]}

Actividad de cada usuario con conteo de extracciones.

Errores

401Unauthorized

Token inválido.

{"msg": "Token inválido"}

GET /api/reportes-avanzados/tipos-documento

Estadísticas agrupadas por tipo de documento.

GET /api/reportes-avanzados/tipos-documento

Headers

Authorization: Bearer JWT_TOKEN

Ejemplos

curl -X GET https://api-docmind.devol.es/api/reportes-avanzados/tipos-documento \
  -H "Authorization: Bearer JWT_TOKEN"

Respuesta

{"tipos": [{"nombre": "Factura", "total": 500, "completadas": 480, "tasa": 96.0}]}

Distribución y tasas de éxito por tipo de documento.

Errores

401Unauthorized

Token inválido.

{"msg": "Token inválido"}

GET /api/reportes-avanzados/rendimiento

Métricas de rendimiento: tiempos de procesamiento, tokens consumidos, costos.

GET /api/reportes-avanzados/rendimiento

Headers

Authorization: Bearer JWT_TOKEN

Ejemplos

curl -X GET https://api-docmind.devol.es/api/reportes-avanzados/rendimiento \
  -H "Authorization: Bearer JWT_TOKEN"

Respuesta

{"tiempo_promedio_segundos": 12.5, "tokens_totales": 500000, "tokens_promedio": 333, "modelo_mas_usado": "gpt-4o-mini"}

Datos de rendimiento del procesamiento de extracciones.

Errores

401Unauthorized

Token inválido.

{"msg": "Token inválido"}

GET /api/reportes-avanzados/errores

Análisis de errores: tipos de error, frecuencia y distribución.

GET /api/reportes-avanzados/errores

Headers

Authorization: Bearer JWT_TOKEN

Ejemplos

curl -X GET https://api-docmind.devol.es/api/reportes-avanzados/errores \
  -H "Authorization: Bearer JWT_TOKEN"

Respuesta

{"errores": [{"tipo": "timeout", "count": 10, "porcentaje": 33.3}, {"tipo": "formato_invalido", "count": 20, "porcentaje": 66.6}], "total_errores": 30}

Distribución de errores por tipo para identificar problemas recurrentes.

Errores

401Unauthorized

Token inválido.

{"msg": "Token inválido"}

GET /api/reportes-avanzados/habilidades

Métricas de uso por habilidad.

GET /api/reportes-avanzados/habilidades

Headers

Authorization: Bearer JWT_TOKEN

Ejemplos

curl -X GET https://api-docmind.devol.es/api/reportes-avanzados/habilidades \
  -H "Authorization: Bearer JWT_TOKEN"

Respuesta

{"habilidades": [{"nombre": "Factura", "slug": "factura", "extracciones": 500, "tasa_exito": 95.0}]}

Uso y rendimiento de cada habilidad.

Errores

401Unauthorized

Token inválido.

{"msg": "Token inválido"}

GET /api/reportes-avanzados/time-range-skills

Métricas por rango temporal desglosadas por habilidad.

GET /api/reportes-avanzados/time-range-skills

Headers

Authorization: Bearer JWT_TOKEN

Query Parameters

  • start_date: (obligatorio) Fecha inicio YYYY-MM-DD
  • end_date: (obligatorio) Fecha fin YYYY-MM-DD

Ejemplos

curl -X GET "https://api-docmind.devol.es/api/reportes-avanzados/time-range-skills?start_date=2025-01-01&end_date=2025-06-30" \
  -H "Authorization: Bearer JWT_TOKEN"

Respuesta

{"data": [{"habilidad": "Factura", "periodo": "2025-01", "total": 80}]}

Datos temporales cruzados con habilidades.

Errores

400Bad Request

Fechas inválidas.

{"error": "Formato de fecha inválido"}

GET /api/reportes-avanzados/status-cliente

Estado general del cliente: extracciones activas, en cola, etc.

GET /api/reportes-avanzados/status-cliente

Headers

Authorization: Bearer JWT_TOKEN

Ejemplos

curl -X GET https://api-docmind.devol.es/api/reportes-avanzados/status-cliente \
  -H "Authorization: Bearer JWT_TOKEN"

Respuesta

{"en_cola": 5, "procesando": 2, "completadas_hoy": 45, "errores_hoy": 1}

Vista rápida del estado operativo actual.

Errores

401Unauthorized

Token inválido.

{"msg": "Token inválido"}

GET /api/reportes-avanzados/entrenamientos

Métricas del sistema de entrenamiento/aprendizaje de habilidades.

GET /api/reportes-avanzados/entrenamientos

Headers

Authorization: Bearer JWT_TOKEN

Ejemplos

curl -X GET https://api-docmind.devol.es/api/reportes-avanzados/entrenamientos \
  -H "Authorization: Bearer JWT_TOKEN"

Respuesta

{"total_sesiones": 25, "aprobadas": 20, "descartadas": 5, "feedback_promedio": 2.3}

Resumen de actividad de entrenamiento y aprendizaje.

Errores

401Unauthorized

Token inválido.

{"msg": "Token inválido"}

© 2025 Devol. Todos los derechos reservados.