Access: System, Admin, and ClientAdmin users only.
This endpoint counts EEOnboarding rows by onboarding type and lifecycle; it is not equivalent to the Team
workforce-count endpoints, which count distinct persons by workforce classification. The response contains
aggregate counts only and never exposes onboarding IDs, employee IDs, names, SSNs, emails, or addresses.
Each data point contains per-period createdCount and erFinishedCount groups, plus
activeCountGroups and totalActiveCount for onboardings active at that data point's
periodEnd, and inSetupCountGroups / totalInSetupCount for current in-setup rows whose
company-local CreatedOn is on or before that data point's periodEnd. The root
waitingForCurrentRoleGroups collection is computed once over the whole effective window, not per data point.
Waiting-for-current-role means EEOnboarding.LockedRoleId = CurrentRole.LoginRoleId and status is Phase 1 or
Phase 2. Phase 1 = Status < EEOnboardingStatus.SentInvitation (Created, ReadyForEr);
Phase 2 = Status == EEOnboardingStatus.EEFinished. All other statuses, including ERFinished, are not
counted as waiting for the caller's current role.
The root totalInSetupForCurrentRoleCount and inSetupForCurrentRoleGroups values are all-time,
window-independent counts of rows with RowStatus = InSetup, LockedRoleId = CurrentRole.LoginRoleId,
and Status < EEOnboardingStatus.SentInvitation.
The root today block is an all-time company-wide snapshot independent of from,
to, and granularity. Its asOfDate is the current company-local date
and is not used as a time filter for the scalar totals. today.totalActiveCount counts eligible rows whose
current status is not ERFinished. today.totalInSetupCount counts all rows with
RowStatus = InSetup and has no time, status, or onboarding-type grouping filter.
The response deliberately has no root-level totalActiveCount aggregate because period-end active snapshots
would double count long-running onboardings across multiple data points. It also deliberately has no root-level
cross-data-point sum of per-data-point totalInSetupCount and no today.inSetupCountGroups collection.
Weekly and bi-weekly periods use the caller role's existing week rules via
CurrentRole.GetWeekOfYearInfo(date). Requests producing more than 500 data points return
400 Bad Request; data points are never truncated and granularity is never silently coarsened.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||