Saltar al contenido principal

Reporte de Línea de Tiempo de Ejecución

Registro cronológico de eventos a través de las ejecuciones de workflow — cada avance de paso, evento de tarea, compuerta y escalamiento, con el actor, el paso y la entidad referenciada.

GET/apidev/v1/reports/workflow/timeline
PermisoAPICLI_RPTWF_TIMELINE
Límite de solicitudes10 req/min
Caché300s
Rango máximo92 días

Resumen​

Devuelve un flujo plano, ordenado en el tiempo, de eventos de ejecución a través de todas las instancias de workflow en un rango de fechas — avances de paso, tareas creadas/completadas/reasignadas/escaladas, evaluaciones de compuertas y otras entradas del registro. Cada evento resuelve el nombre del workflow, el nombre del paso, el usuario actuante y la entidad de negocio que referencia (por ejemplo TAREA #1234), para que puedas auditar exactamente qué pasó y cuándo. Se cubren tanto las instancias activas como las archivadas.

Los resultados se paginan. El tamaño de página por defecto es 50. Filtrá por una o más definiciones de workflow para acotar la línea de tiempo a procesos específicos.


Solicitud​

Encabezados de la solicitud​

Every request to a protected endpoint requires these headers:

HeaderRequiredDescription
AuthorizationYesBearer token obtained from the Login endpoint. Format: Bearer <token>
X-API-KeyYesCompany integration key provided during onboarding. Format: gtk_xxx...
tenantYesYour assigned tenant domain (default: geotareas.com) — always send your assigned tenant
Content-TypeConditionalapplication/json — required for POST and PUT requests

Parámetros de consulta​

ParámetroTipoRequeridoPor defectoDescripción
startdatestringSí—Fecha-hora de inicio en ISO 8601 (ej. 2026-03-01T00:00:00).
enddatestringSí—Fecha-hora de fin en ISO 8601. Rango máximo de 92 días desde startdate.
definition_idsstringNo—IDs de definición de workflow para filtrar, separados por comas. Máximo 100.
sort_bystringNotimestampColumna por la cual ordenar. Una de: timestamp, instanceId, workflowName, eventType, actorName.
sort_dirstringNodescDirección de ordenamiento: asc o desc.
limitintegerNo25Cantidad de registros por página (1–100).
offsetintegerNo0Cantidad de registros a omitir para la paginación.
sort_by se valida por reporte

Este reporte acepta exactamente estos valores:

timestamp · instanceId · workflowName · eventType · actorName

Cualquier otro valor devuelve 400 VALIDATION_ERROR, y el mensaje enumera los valores aceptados. Hasta el 2026-08-16 un sort_by no reconocido se ignoraba en silencio y el reporte volvía en su orden por defecto, así que una columna mal escrita parecía haber funcionado.


Ejemplos de código​

curl -s -H "Authorization: Bearer $TOKEN" \
-H "X-API-Key: $APIKEY" \
-H "tenant: $TENANT" \
"https://$TENANT/apidev/v1/reports/workflow/timeline?startdate=2026-03-01T00:00:00&enddate=2026-03-31T23:59:59&sort_dir=asc&limit=50"

Respuesta​

Campos de la respuesta​

Cada elemento en data representa un evento de ejecución.

CampoTipoDescripción
logIdstringID de la entrada del registro de eventos.
timestampstringFecha-hora del evento (ISO 8601).
instanceIdstringID de la instancia de workflow a la que pertenece el evento.
workflowNamestringNombre de la definición de workflow.
stepNamestringPaso en el que ocurrió el evento (- cuando el evento no está ligado a un paso).
eventTypestringCódigo de tipo de evento (ej. TASK_COMPLETED, STEP_ADVANCED, TASK_ESCALATED).
actorNamestringNombre del usuario que disparó el evento (- para eventos del sistema).
messagestringMensaje legible del evento.
entityTypestring | nullTipo de la entidad de negocio referenciada (ej. TAREA, CUENTA).
entityIdstring | nullID de la entidad de negocio referenciada.
entityRefstringReferencia legible, ej. TAREA #1234; vuelve al nombre del workflow cuando no hay entidad vinculada.

Respuesta de ejemplo​

{
"success": true,
"data": [
{
"logId": "9920011223344556",
"timestamp": "2026-03-12T09:41:00",
"instanceId": "8842001122334455",
"workflowName": "Incident Resolution",
"stepName": "Field Validation",
"eventType": "TASK_COMPLETED",
"actorName": "Carlos Martinez",
"message": "Task completed with result OK",
"entityType": "TAREA",
"entityId": "1234",
"entityRef": "TAREA #1234"
}
],
"meta": {
"total": 1,
"limit": 50,
"offset": 0
}
}

Errores​

CódigoHTTPDescripción
VALIDATION_ERROR400Parámetros inválidos: fechas faltantes, valores de enum inválidos, paginación fuera de rango.
INVALID_DATE_RANGE400Rango de fechas inválido o mayor a 92 días.
UNAUTHORIZED401tenant / Authorization / X-API-Key faltante, inválido o expirado
FORBIDDEN403El usuario no tiene el permiso requerido.
RATE_LIMITED429Se superaron las 10 req/min.
INTERNAL_ERROR500Error inesperado del servidor.