API Docs / Operations / Reports / Get Client Responsiveness Report

Get Client Responsiveness Report

GET /tenants/{tenant}/reports/client-responsiveness

Is it us or the client: response times and chase pressure over client-facing workflow steps (confirmations, document requests, data forms, approvals) completed in the window, grouped by client, service, or step type, plus the currently-outstanding snapshot.

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

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

startDate query string

Step-completion window start (inclusive). Only valid when dateRange=CustomDateRange

Step-completion window start (inclusive). Only valid when dateRange=CustomDateRange

endDate query string

Step-completion window end (inclusive). Only valid when dateRange=CustomDateRange

Step-completion window end (inclusive). Only valid when dateRange=CustomDateRange

groupBy query string

Breakdown dimension: Client (default), Service, or StepType

Breakdown dimension: Client (default), Service, or StepType

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

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