Skip to main content

Execution Timeline Report

Chronological event log across workflow executions — each step advance, task event, gateway, and escalation with actor, step, and referenced entity.

GET/apidev/v1/reports/workflow/timeline
PermissionAPICLI_RPTWF_TIMELINE
Rate Limit10 req/min
Cache300s
Max Range92 days

Overview​

Returns a flat, time-ordered stream of execution events across all workflow instances in a date range — step advances, task created/completed/reassigned/escalated, gateway evaluations, and other log entries. Each event resolves the workflow name, step name, acting user, and the business entity it references (for example TAREA #1234), so you can audit exactly what happened and when. Both active and archived instances are covered.

Results are paginated. The default page size is 25. Filter by one or more workflow definitions to scope the timeline to specific processes.


Request​

Request Headers​

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

Query Parameters​

ParameterTypeRequiredDefaultDescription
startdatestringYes—ISO 8601 start date-time (e.g. 2026-03-01T00:00:00).
enddatestringYes—ISO 8601 end date-time. Max range 92 days from startdate.
definition_idsstringNo—Comma-separated workflow definition IDs to filter by. Max 100.
sort_bystringNotimestampColumn to sort by. One of: timestamp, instanceId, workflowName, eventType, actorName.
sort_dirstringNodescSort direction: asc or desc.
limitintegerNo25Number of records per page (1–100).
offsetintegerNo0Number of records to skip for pagination.
sort_by is validated per report

This report accepts exactly these values:

timestamp · instanceId · workflowName · eventType · actorName

Anything else returns 400 VALIDATION_ERROR, and the message names the accepted values. Until 2026-08-16 an unrecognised sort_by was silently ignored and the report came back in its default order, so a mis-typed column looked like it had worked.


Code Examples​

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"

Response​

Response Fields​

Each item in data represents one execution event.

FieldTypeDescription
logIdstringEvent log entry ID.
timestampstringEvent date-time (ISO 8601).
instanceIdstringWorkflow instance ID the event belongs to.
workflowNamestringWorkflow definition name.
stepNamestringStep the event occurred at (- when the event is not tied to a step).
eventTypestringEvent type code (e.g. TASK_COMPLETED, STEP_ADVANCED, TASK_ESCALATED).
actorNamestringName of the user who triggered the event (- for system events).
messagestringHuman-readable event message.
entityTypestring | nullType of the referenced business entity (e.g. TAREA, CUENTA).
entityIdstring | nullID of the referenced business entity.
entityRefstringReadable reference, e.g. TAREA #1234; falls back to the workflow name when no entity is linked.

Example Response​

{
"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
}
}

Errors​

CodeHTTPDescription
VALIDATION_ERROR400Invalid params: missing dates, invalid enum values, out-of-range pagination.
INVALID_DATE_RANGE400Date range invalid or greater than 92 days.
UNAUTHORIZED401Missing, invalid, or expired tenant / Authorization / X-API-Key
FORBIDDEN403User lacks required permission.
RATE_LIMITED429Exceeded 10 req/min.
INTERNAL_ERROR500Unexpected server error.