Get Task Workload Summary
Returns the four standard workload bucket counts in one call: overdue, due today,
due this week, and in progress.
Accepts the task list's scope filters (user, team, isUnassigned, client, category,
service, workflow and includeProjected). Date, status, isOverdue, search and
includeWorkflowSteps parameters are rejected — the buckets define their own dates
and statuses, and count a scope rather than a search.
Parameters
| Name | Type | Description |
|---|---|---|
| tenant* | path string | The Tenant.Code |
The Tenant.Code |
||
| client | query array | Filter by client code(s) - can specify multiple |
Filter by client code(s) - can specify multiple |
||
| user | query array | Filter by user code(s) - can specify multiple |
Filter by user code(s) - can specify multiple |
||
| recurringTask | query array | Filter by recurring task code(s) - can specify multiple |
Filter by recurring task code(s) - can specify multiple |
||
| service | query array | Filter by billable service code(s) - can specify multiple |
Filter by billable service code(s) - can specify multiple |
||
| category | query array | Filter by task category code(s) - can specify multiple |
Filter by task category code(s) - can specify multiple |
||
| team | query array | Filter by team code(s) - can specify multiple |
Filter by team code(s) - can specify multiple |
||
| workflow | query array | Filter by workflow code(s) - can specify multiple |
Filter by workflow code(s) - can specify multiple |
||
| stepType | query array | Filter by workflow step type(s) - matches tasks with at least one step of these types |
Filter by workflow step type(s) - matches tasks with at least one step of these types |
||
| currentStep | query array | Filter by current workflow step name(s) - can specify multiple |
Filter by current workflow step name(s) - can specify multiple |
||
| status | query array | Filter by task status(es) |
Filter by task status(es) |
||
| includeWorkflowSteps | query boolean | Include workflow steps in the results (default: false). When true, uses Agenda mode. |
Include workflow steps in the results (default: false). When true, uses Agenda mode. |
||
| dateRange | query string | Preset date range. If CustomDateRange, startDate and endDate are required. |
Preset date range. If CustomDateRange, startDate and endDate are required. |
||
| startDate | query string | Filter tasks starting from this date. Only valid when dateRange=CustomDateRange |
Filter tasks starting from this date. Only valid when dateRange=CustomDateRange |
||
| endDate | query string | Filter tasks ending on this date. Only valid when dateRange=CustomDateRange |
Filter tasks ending on this date. Only valid when dateRange=CustomDateRange |
||
| includeProjected | query boolean | Include projected (virtual) tasks in the results (default: false) |
Include projected (virtual) tasks in the results (default: false) |
||
| projectUntil | query string | Projection horizon for a query with no date range. Requires includeProjected=true and no date range; projects from today to this date while the materialised query stays unbounded. |
Projection horizon for a query with no date range. Requires includeProjected=true and no date range; projects from today to this date while the materialised query stays unbounded. |
||
| dateBasis | query string | Which date field to use as the basis for filtering: StartDate (default) or DueDate |
Which date field to use as the basis for filtering: StartDate (default) or DueDate |
||
| isOverdue | query boolean | Filter to only include overdue tasks (DueDate < today). No date range required when true. |
Filter to only include overdue tasks (DueDate < today). No date range required when true. |
||
| isUnassigned | query boolean | Include unassigned tasks. Can be combined with user filter to show unassigned OR assigned to specific users. |
Include unassigned tasks. Can be combined with user filter to show unassigned OR assigned to specific users. |
||
| isAutomationDisabled | query boolean | True returns only tasks with automation switched off; false only those with it on. Task previews are excluded either way. |
True returns only tasks with automation switched off; false only those with it on. Task previews are excluded either way. |
||
| search | query string | Search across task name, task code and primary client name (minimum 3 characters). Projected tasks are excluded when set. |
Search across task name, task code and primary client name (minimum 3 characters). Projected tasks are excluded when set. |
||