API Docs / Operations / Reports / Get Deadline Compliance Report

Get Deadline Compliance Report

GET /tenants/{tenant}/reports/deadline-compliance

Which deadlines did we miss, and which are we about to? The cohort is every non-Skipped task whose chosen deadline (due date, or statutory due date via deadlineType) fell in the window - met / completed-late / missed-still-open / pending - grouped by service, client, assignee, or deadline month, plus the forward-looking days-remaining buckets over currently-open work.

Parameters

NameTypeDescription
tenant* path string

The Tenant.Code

The Tenant.Code

offset query integer (int32)

Number of records to skip (default: 0). Use with limit for pagination.

Number of records to skip (default: 0). Use with limit for pagination.

limit query integer (int32)

Maximum number of records to return (default: 10, max: 50)

Maximum number of records to return (default: 10, max: 50)

dateRange query string

Preset date range for the deadline window (default Last30Days). If CustomDateRange, startDate and endDate are required.

Preset date range for the deadline window (default Last30Days). If CustomDateRange, startDate and endDate are required.

startDate query string

Deadline window start (inclusive). Only valid when dateRange=CustomDateRange

Deadline window start (inclusive). Only valid when dateRange=CustomDateRange

endDate query string

Deadline window end (inclusive). Only valid when dateRange=CustomDateRange

Deadline window end (inclusive). Only valid when dateRange=CustomDateRange

groupBy query string

Breakdown dimension: Service (default), Client, AssignedUser, or Month

Breakdown dimension: Service (default), Client, AssignedUser, or Month

deadlineType query string

Deadline to measure against: DueDate (default) or StatutoryDueDate (restricts to tasks that have one)

Deadline to measure against: DueDate (default) or StatutoryDueDate (restricts to tasks that have one)

service query array

Filter by billable service code(s) - can specify multiple

Filter by billable service code(s) - can specify multiple

client query array

Filter by client code(s) - can specify multiple

Filter by client code(s) - can specify multiple

user query array

Filter by assigned user code(s) - can specify multiple

Filter by assigned user code(s) - can specify multiple

team query array

Filter by assigned team code(s) - can specify multiple

Filter by assigned team 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

Responses

400 Bad Request
401 Unauthorized – Invalid or missing API key