GET Statistics/Units?UnitType={UnitType}&UnitLevel={UnitLevel}&ParentUnitId={ParentUnitId}

Get Wait and Service counts and time statistics for each unit

Request Information

URI Parameters

NameDescriptionTypeAdditional information
UnitType

Unit Type Id. optional.

integer

None.

UnitLevel

Unit Level, 0 based. optional

integer

None.

ParentUnitId

Parent's Unit Id. optional

integer

None.

Body Parameters

None.

Response Information

Resource Description

Table of Statistics

Collection of StatisticsUnitResult
NameDescriptionTypeAdditional information
UnitId

Unit Id

integer

None.

UnitName

Unit Name

string

Max length: 50

UnitDescription

Unit Description

string

Max length: 250

UnitTypeId

Unit Type Id

integer

None.

ParentUnitId

Parent Unit Id

integer

None.

UnitLevel

Unit Level (0=root unit)

integer

None.

ServiceCount

Realtime - Number of customers being served

integer

None.

AvgServiceTime

Realtime - Average service time (seconds)

integer

None.

WaitCount

Realtime - Waiting customer count

integer

None.

AvgWaitTime

Realtime - Average waiting time (seconds)

integer

None.

UsersAvail

Realtime - Agents available

integer

None.

LocationsInUse

Realtime - Counters in use

integer

None.

Locations

Realtime - Total counters

integer

None.

TodayCount

Number of customers today

integer

None.

TodayServiceCount

Number of customers served today

integer

None.

TodayWaitCount

Number of customers waited today

integer

None.

TodayAbandonCount

Number of customers abandoned today

integer

None.

TodayAvgWaitTime

Average waiting time today (seconds)

integer

None.

TodayAvgServiceTime

Average service time today (seconds)

integer

None.

TodaySLA

Number of customers waited today under the target wait time

integer

None.

IsInWorkHours

Is the unit within working hours (from Working Hours cache)

boolean

None.

WaitingTimeTarget

Waiting time target in seconds (used for high-lighting high wait times) Based on Maximum Waiting Time Target with failover to Waiting Time Critical in Service Profiles in this unit

integer

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "UnitId": 1,
    "UnitName": "sample string 2",
    "UnitDescription": "sample string 3",
    "UnitTypeId": 4,
    "ParentUnitId": 5,
    "UnitLevel": 6,
    "ServiceCount": 7,
    "AvgServiceTime": 8,
    "WaitCount": 9,
    "AvgWaitTime": 10,
    "UsersAvail": 11,
    "LocationsInUse": 12,
    "Locations": 13,
    "TodayCount": 14,
    "TodayServiceCount": 15,
    "TodayWaitCount": 16,
    "TodayAbandonCount": 17,
    "TodayAvgWaitTime": 18,
    "TodayAvgServiceTime": 19,
    "TodaySLA": 20,
    "IsInWorkHours": true,
    "WaitingTimeTarget": 22
  },
  {
    "UnitId": 1,
    "UnitName": "sample string 2",
    "UnitDescription": "sample string 3",
    "UnitTypeId": 4,
    "ParentUnitId": 5,
    "UnitLevel": 6,
    "ServiceCount": 7,
    "AvgServiceTime": 8,
    "WaitCount": 9,
    "AvgWaitTime": 10,
    "UsersAvail": 11,
    "LocationsInUse": 12,
    "Locations": 13,
    "TodayCount": 14,
    "TodayServiceCount": 15,
    "TodayWaitCount": 16,
    "TodayAbandonCount": 17,
    "TodayAvgWaitTime": 18,
    "TodayAvgServiceTime": 19,
    "TodaySLA": 20,
    "IsInWorkHours": true,
    "WaitingTimeTarget": 22
  }
]