Skip to main content

Group Activity Report

Workload and throughput per assignment group — member count, assigned vs completed tasks, average completion time, and SLA compliance.

GET/apidev/v1/reports/workflow/group-activity
PermissionAPICLI_RPTWF_GRUPOS
Rate Limit10 req/min
Cache300s
Max Range92 days

Overview​

Aggregates task activity for each workflow assignment group over a date range — number of members, tasks assigned to the group, tasks the group completed, average completion time, and SLA compliance. Use it to balance workload across teams and to identify groups that are overloaded or under-utilized. Only tasks assigned to a group are counted; tasks assigned directly to an individual without a group are excluded. Both active and archived tasks are included.

Results are paginated and can be ordered by any of the activity columns. Filter by one or more workflow definitions to scope the report to specific processes.

SLA compliance requires SLA configuration

The sla_compliance_percent field reflects real values only when SLA tracking is enabled for your company. When SLA is not configured, this field defaults to 100 for every group. Contact your account team to enable per-step SLA tracking.


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_bystringNoassignedTasksColumn to sort by. One of: assignedTasks, completedTasks, avgCompletionSeconds, memberCount, groupName, slaMet, slaTotal.
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:

assignedTasks · completedTasks · avgCompletionSeconds · memberCount · groupName · slaMet · slaTotal

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/group-activity?startdate=2026-03-01T00:00:00&enddate=2026-03-31T23:59:59&limit=25"

Response​

Response Fields​

Each item in data represents one assignment group.

FieldTypeDescription
groupIdstringAssignment group ID.
groupNamestringAssignment group name.
memberCountnumberNumber of members in the group.
assignedTasksnumberTasks assigned to the group in the period.
completedTasksnumberTasks the group completed.
slaCompliancePercentnumberSLA compliance percentage (defaults to 100 when SLA is not configured).
avgCompletionSecondsnumberAverage completion time (seconds) of completed tasks.

Example Response​

{
"success": true,
"data": [
{
"groupId": "7710045566778899",
"groupName": "Field Operations",
"memberCount": 8,
"assignedTasks": 312,
"completedTasks": 287,
"slaCompliancePercent": 88.5,
"avgCompletionSeconds": 3640.0
}
],
"meta": {
"total": 1,
"limit": 25,
"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.