Jump to: navigation, search
Line 24: Line 24:
 
* name - the name of statistic as it appears in API request
 
* name - the name of statistic as it appears in API request
 
* statisticDefinitionName - the name of statistic type (definition) as it's in CME ({{Repository|81fr_us-statserver.pdf|01cbd701-da38-49b6-b984-394ca06187e8|Stat Server User's Guide}})
 
* statisticDefinitionName - the name of statistic type (definition) as it's in CME ({{Repository|81fr_us-statserver.pdf|01cbd701-da38-49b6-b984-394ca06187e8|Stat Server User's Guide}})
 
{{Repository|DOC_NAME|DOC_ID|DESCRIPTION}}
 
 
([[http://docs.genesyslab.com/Special:Repository/81fr_us-statserver.pdf?id=01cbd701-da38-49b6-b984-394ca06187e8 |See Stat Server User’s Guide]])
 
 
* objectType - the type of objects statistic is applied. Possible values: AGENT|QUEUE|SKILL_Q|SKILL_AG:
 
* objectType - the type of objects statistic is applied. Possible values: AGENT|QUEUE|SKILL_Q|SKILL_AG:
 
** AGENT - statistic is monitored for agents
 
** AGENT - statistic is monitored for agents
Line 35: Line 31:
 
* notificationMode - PERIODICAL
 
* notificationMode - PERIODICAL
 
* notificationFrequency - the frequency of notification (in seconds)
 
* notificationFrequency - the frequency of notification (in seconds)
* timeProfile - the name of timeProfile in Configuration Manager used for statistic aggregation ([[http://docs.genesyslab.com/Special:Repository/81fr_us-statserver.pdf?id=01cbd701-da38-49b6-b984-394ca06187e8 |See Stat Server User’s Guide]])
+
* timeProfile - the name of timeProfile in Configuration Manager used for statistic aggregation ({{Repository|81fr_us-statserver.pdf|01cbd701-da38-49b6-b984-394ca06187e8|Stat Server User's Guide}})
* timeRange/timeRange2 - the timeranges names which are defined in Configuration Manager and are used for calculating statistic. ([[http://docs.genesyslab.com/Special:Repository/81fr_us-statserver.pdf?id=01cbd701-da38-49b6-b984-394ca06187e8 |See Stat Server User’s Guide]]).
+
* timeRange/timeRange2 - the timeranges names which are defined in Configuration Manager and are used for calculating statistic. ({{Repository|81fr_us-statserver.pdf|01cbd701-da38-49b6-b984-394ca06187e8|Stat Server User's Guide}}).
  
 
</toggledisplay>
 
</toggledisplay>

Revision as of 17:30, September 6, 2017

Monitored statistics

This document is part of the Statistics API portion of the Web Services API.

Entry Format

Two modes of statistics definitions are supported, "simple" and "extended". In "simple" mode, the statistic type is defined in Configuration Manager and the statistics.yaml entry defines the additional statistics options and the statistic name in the API. In "extended" mode, the full definition of the statistic is provided in statistics.yaml entry. In this case there is no need to use Configuration Manager for statistic definition. The switch between modes is defined basing on presence of statisticDefinitionEx property. If the specified mode is in "extended" mode, statisticDefinitionName is ignored if present.

Simple Mode Entry Format

[+] Simple Mode Entry Format

Extended mode entry format

[+] Extended Mode Entry Format

Queue Statistics

[+] Total_Answered

[+] Total_Abandoned

[+] Current_In_Queue

[+] CurrMaxCallWaitingTime

[+] ServiceLevel

[+] AverageWaitingTime

Skills Statistics

[+] CurrentNotReadyAgents

[+] CurrentReadyAgents

[+] CurrNumberInCall

[+] LongestIdleTime

[+] AverageHandlingTime

[+] ServiceLevel

Agent Statistics

[+] AverageHandlingTime

[+] Productivity

[+] InboundCalls

[+] InternalCalls

[+] OutboundCalls

[+] ConsultCalls

[+] ReadyDuration

[+] WrapDuration

[+] TalkDuration

[+] HoldDuration

Agent Statistics for eServices

[+] AverageHandlingTime_Chat

[+] AverageHandlingTime_Email

[+] Productivity_Chat

[+] Productivity_Email

[+] InboundChats

[+] InboundEmails

[+] ChatDuration

[+] EmailDuration

[+] TimeInCurrentChat

[+] TimeInCurrentEmail

[+] OutboundEmails

[+] TransferredChats

[+] MissedChats

[+] RejectedChats

[+] TransferredEmails

[+] MissedEmails

[+] RejectedEmails

[+] ReadyDuration_Email

[+] ReadyDuration_Chat

Resources

See Enabling Reporting in the Workspace Web Edition & Web Services Deployment Guide.

See Configuring Virtual Queues & Virtual Agent Groups in the Workspace Web Edition & Web Services Deployment Guide.

This list is the minimal list - it contains only statistics which are required for current version of UI.

[+] Sample statistics.yaml file

Comments or questions about this documentation? Contact us for support!