API Docs / Operations / Reports / Get Service Delivery Report

Get Service Delivery Report

GET /tenants/{tenant}/reports/service-delivery

Service Delivery Turnaround: headline KPIs (avg/median turnaround, on-time rate, statutory compliance, currently overdue) plus a breakdown table grouped by service, client, assignee, or completion month. The cohort is tasks completed in the requested window; Skipped tasks are excluded unless includeSkipped=true.

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 completion window (default Last30Days). If CustomDateRange, startDate and endDate are required.

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

startDate query string

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

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

endDate query string

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

Completion 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

includeSkipped query boolean

Count Skipped tasks as delivered alongside Completed ones (default false)

Count Skipped tasks as delivered alongside Completed ones (default false)

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