API Docs / Schemas / StepBottleneckDto

StepBottleneckDto

Duration aggregates for one workflow step across the cohort's workflow tasks for a single
billable service. A step's duration runs from the previous step's completion (or the task's
actual start for the first step) to its own completion, so it includes idle time waiting
for the step to begin - the "where do tasks sit" measure.

Properties

Name Type Description
groupNamestring

The workflow group (section) the step belongs to - lets the UI divide the step table
into the same sections the workflow shows.

The workflow group (section) the step belongs to - lets the UI divide the step table
into the same sections the workflow shows.

stepNamestring

Step name (snapshotted per task; renamed steps aggregate separately).

Step name (snapshotted per task; renamed steps aggregate separately).

stepTypeenum

Standard SendEmail DocumentRequest DocumentApproval ClientConfirmation SendDataForm SetServiceStage UpdateClientData SetPipelineStage

Standard SendEmail DocumentRequest DocumentApproval ClientConfirmation SendDataForm SetServiceStage UpdateClientData SetPipelineStage

stageClientBillableServiceStageDto
isClientWaitboolean

True when the step completes on a client action - its elapsed time is client-wait time
(DocumentRequest, DocumentApproval, ClientConfirmation, SendDataForm). False = internal time.

True when the step completes on a client action - its elapsed time is client-wait time
(DocumentRequest, DocumentApproval, ClientConfirmation, SendDataForm). False = internal time.

countinteger

Number of step instances (completed or skipped) aggregated into this row.

Number of step instances (completed or skipped) aggregated into this row.

avgDurationDaysnumber

Average elapsed days from the previous step's completion to this step's completion.

Average elapsed days from the previous step's completion to this step's completion.

skippedCountinteger

How many of the instances were skipped rather than completed. Skipped steps stay in the
averages (their elapsed time is real time the task sat there) - this column makes that visible.

How many of the instances were skipped rather than completed. Skipped steps stay in the
averages (their elapsed time is real time the task sat there) - this column makes that visible.

avgChaseCountnumber

Average number of chases sent for this step (client-facing steps only; 0 elsewhere).

Average number of chases sent for this step (client-facing steps only; 0 elsewhere).

JSON Example

{
  "groupName": "string",
  "stepName": "string",
  "stepType": "Standard",
  "stage": {
    "code": "string",
    "name": "string",
    "icon": "string",
    "color": "string",
    "setTime": "2024-01-01T00:00:00Z"
  },
  "isClientWait": false
}

Contained in Schemas