Jump to: navigation, search
(→‎Agent Statistics for eServices)
 
(8 intermediate revisions by 4 users not shown)
Line 1: Line 1:
−
= List of statistics to be monitored=
+
= Monitored statistics =
−
This document is part of the [[StatisticsAPI | Statistics API]] portion of the [[Welcome | Genesys Web Services REST API]].
+
This document is part of the [[StatisticsAPI|Statistics API]] portion of the [[Welcome|Web Services API]].
 
__TOC__
 
__TOC__
  
Line 23: Line 23:
 
The properties meaning are:
 
The properties meaning are:
 
* 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 ([[http://docs.genesyslab.com/Special:Repository/81fr_us-statserver.pdf?id=01cbd701-da38-49b6-b984-394ca06187e8 |See Stat Server User’s Guide]])
+
* statisticDefinitionName - the name of statistic type (definition) as it's in CME (see {{Repository|81fr_us-statserver.pdf|01cbd701-da38-49b6-b984-394ca06187e8 |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|VIRTUAL_QUEUE:
 
** AGENT - statistic is monitored for agents
 
** AGENT - statistic is monitored for agents
 
** QUEUE - statistic is monitored for queues
 
** QUEUE - statistic is monitored for queues
 
** SKILL_AG - statistic is monitored for agentGroup, associated with skill
 
** SKILL_AG - statistic is monitored for agentGroup, associated with skill
 
** SKILL_Q - statistic is monitored for virtual queue, associated with skill
 
** SKILL_Q - statistic is monitored for virtual queue, associated with skill
 +
** VIRTUAL_QUEUE - statistic is monitored for virtual queues
 
* 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 (see {{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 (see {{Repository|81fr_us-statserver.pdf|01cbd701-da38-49b6-b984-394ca06187e8 |Stat Server User’s Guide}})
  
 
</toggledisplay>
 
</toggledisplay>
Line 142: Line 143:
 
|}
 
|}
  
−
Note that those properties are used for defining the statistics. Not all combinations are supported by StatServer. See [http://docs.genesyslab.com/Special:Repository/81fr_us-statserver.pdf?id=01cbd701-da38-49b6-b984-394ca06187e8 |File:81fr us-statserver.pdf Stat Server user guide] for more info.
+
Note that those properties are used for defining the statistics. Not all combinations are supported by StatServer. See {{Repository|81fr_us-statserver.pdf|01cbd701-da38-49b6-b984-394ca06187e8 |Stat Server user guide}} for more info.
  
 
</toggledisplay>
 
</toggledisplay>
Line 510: Line 511:
  
 
==Agent Statistics for eServices==
 
==Agent Statistics for eServices==
−
<p><toggledisplay showtext="[+] <name>" hidetext="[-] <name>">
+
<p><toggledisplay showtext="[+] AverageHandlingTime_Chat" hidetext="[-] AverageHandlingTime_Chat">
 
<pre>
 
<pre>
 
name: AverageHandlingTime_Chat
 
name: AverageHandlingTime_Chat
Line 529: Line 530:
 
</toggledisplay></p>
 
</toggledisplay></p>
  
−
<p><toggledisplay showtext="[+] <name>" hidetext="[-] <name>">
+
<p><toggledisplay showtext="[+] AverageHandlingTime_Email" hidetext="[-] AverageHandlingTime_Email">
 
<pre>
 
<pre>
 
name: AverageHandlingTime_Email
 
name: AverageHandlingTime_Email
Line 548: Line 549:
 
</toggledisplay></p>
 
</toggledisplay></p>
  
−
<p><toggledisplay showtext="[+] <name>" hidetext="[-] <name>">
+
<p><toggledisplay showtext="[+] Productivity_Chat" hidetext="[-] Productivity_Chat">
 
<pre>
 
<pre>
 
name: Productivity_Chat
 
name: Productivity_Chat
Line 567: Line 568:
 
</toggledisplay></p>
 
</toggledisplay></p>
  
−
<p><toggledisplay showtext="[+] <name>" hidetext="[-] <name>">
+
<p><toggledisplay showtext="[+] Productivity_Email" hidetext="[-] Productivity_Email">
 
<pre>
 
<pre>
 
name: Productivity_Email
 
name: Productivity_Email
Line 586: Line 587:
 
</toggledisplay></p>
 
</toggledisplay></p>
  
−
<p><toggledisplay showtext="[+] <name>" hidetext="[-] <name>">
+
<p><toggledisplay showtext="[+] InboundChats" hidetext="[-] InboundChats">
 
<pre>
 
<pre>
 
name: InboundChats
 
name: InboundChats
Line 604: Line 605:
 
</toggledisplay></p>
 
</toggledisplay></p>
  
−
<p><toggledisplay showtext="[+] <name>" hidetext="[-] <name>">
+
<p><toggledisplay showtext="[+] InboundEmails" hidetext="[-] InboundEmails">
 
<pre>
 
<pre>
 
name: InboundEmails
 
name: InboundEmails
Line 622: Line 623:
 
</toggledisplay></p>
 
</toggledisplay></p>
  
−
<p><toggledisplay showtext="[+] <name>" hidetext="[-] <name>">
+
<p><toggledisplay showtext="[+] ChatDuration" hidetext="[-] ChatDuration">
 
<pre>
 
<pre>
 
name: ChatDuration
 
name: ChatDuration
Line 640: Line 641:
 
</toggledisplay></p>
 
</toggledisplay></p>
  
−
<p><toggledisplay showtext="[+] <name>" hidetext="[-] <name>">
+
<p><toggledisplay showtext="[+] EmailDuration" hidetext="[-] EmailDuration">
 
<pre>
 
<pre>
 
name: EmailDuration
 
name: EmailDuration
Line 658: Line 659:
 
</toggledisplay></p>
 
</toggledisplay></p>
  
−
<p><toggledisplay showtext="[+] <name>" hidetext="[-] <name>">
+
<p><toggledisplay showtext="[+] TimeInCurrentChat" hidetext="[-] TimeInCurrentChat">
 
<pre>
 
<pre>
 
name: TimeInCurrentChat
 
name: TimeInCurrentChat
Line 674: Line 675:
 
</toggledisplay></p>
 
</toggledisplay></p>
  
−
<p><toggledisplay showtext="[+] <name>" hidetext="[-] <name>">
+
<p><toggledisplay showtext="[+] TimeInCurrentEmail" hidetext="[-] TimeInCurrentEmail">
 
<pre>
 
<pre>
 
name: TimeInCurrentEmail
 
name: TimeInCurrentEmail
Line 690: Line 691:
 
</toggledisplay></p>
 
</toggledisplay></p>
  
−
<p><toggledisplay showtext="[+] <name>" hidetext="[-] <name>">
+
<p><toggledisplay showtext="[+] OutboundEmails" hidetext="[-] OutboundEmails">
 
<pre>
 
<pre>
 
name: OutboundEmails
 
name: OutboundEmails
Line 708: Line 709:
 
</toggledisplay></p>
 
</toggledisplay></p>
  
−
<p><toggledisplay showtext="[+] <name>" hidetext="[-] <name>">
+
<p><toggledisplay showtext="[+] TransferredChats" hidetext="[-] TransferredChats">
 
<pre>
 
<pre>
 
name: TransferredChats
 
name: TransferredChats
Line 726: Line 727:
 
</toggledisplay></p>
 
</toggledisplay></p>
  
−
<p><toggledisplay showtext="[+] <name>" hidetext="[-] <name>">
+
<p><toggledisplay showtext="[+] MissedChats" hidetext="[-] MissedChats">
 
<pre>
 
<pre>
 
name: MissedChats
 
name: MissedChats
Line 744: Line 745:
 
</toggledisplay></p>
 
</toggledisplay></p>
  
−
<p><toggledisplay showtext="[+] <name>" hidetext="[-] <name>">
+
<p><toggledisplay showtext="[+] RejectedChats" hidetext="[-] RejectedChats">
 
<pre>
 
<pre>
 
name: RejectedChats
 
name: RejectedChats
Line 762: Line 763:
 
</toggledisplay></p>
 
</toggledisplay></p>
  
−
<p><toggledisplay showtext="[+] <name>" hidetext="[-] <name>">
+
<p><toggledisplay showtext="[+] TransferredEmails" hidetext="[-] TransferredEmails">
 
<pre>
 
<pre>
 
name: TransferredEmails
 
name: TransferredEmails
Line 780: Line 781:
 
</toggledisplay></p>
 
</toggledisplay></p>
  
−
<p><toggledisplay showtext="[+] <name>" hidetext="[-] <name>">
+
<p><toggledisplay showtext="[+] MissedEmails" hidetext="[-] MissedEmails">
 
<pre>
 
<pre>
 
name: MissedEmails
 
name: MissedEmails
Line 798: Line 799:
 
</toggledisplay></p>
 
</toggledisplay></p>
  
−
<p><toggledisplay showtext="[+] <name>" hidetext="[-] <name>">
+
<p><toggledisplay showtext="[+] RejectedEmails" hidetext="[-] RejectedEmails">
 
<pre>
 
<pre>
 
name: RejectedEmails
 
name: RejectedEmails
Line 816: Line 817:
 
</toggledisplay></p>
 
</toggledisplay></p>
  
−
<p><toggledisplay showtext="[+] <name>" hidetext="[-] <name>">
+
<p><toggledisplay showtext="[+] ReadyDuration_Email" hidetext="[-] ReadyDuration_Email">
 
<pre>
 
<pre>
 
name: ReadyDuration_Email
 
name: ReadyDuration_Email
Line 834: Line 835:
 
</toggledisplay></p>
 
</toggledisplay></p>
  
−
<p><toggledisplay showtext="[+] <name>" hidetext="[-] <name>">
+
<p><toggledisplay showtext="[+] ReadyDuration_Chat" hidetext="[-] ReadyDuration_Chat">
 
<pre>
 
<pre>
 
name: ReadyDuration_Chat
 
name: ReadyDuration_Chat
Line 853: Line 854:
  
 
==Resources==
 
==Resources==
−
See [http://docs.genesyslab.com/Documentation/HTCC/8.5.1/Dep/ReportingConfiguration#Enabling_Reporting Enabling Reporting] in the ''Workspace Web Edition & Web Services Deployment Guide''.
+
See [[Documentation:HTCC:Dep:ReportingConfiguration#Enabling_reporting|Enabling reporting]] in the ''Web Services and Applications Deployment Guide''.
−
 
+
<!-- See [[Documentation:HTCC:Dep:ReportingConfiguration#Configuring_Virtual_Queues_.26_Virtual_Agent_Groups|Configuring Virtual Queues & Virtual Agent Groups]] in the ''Workspace Web Edition & Web Services Deployment Guide''. -->
−
See [http://docs.genesyslab.com/Documentation/HTCC/8.5.1/Dep/ReportingConfiguration#Configuring_Virtual_Queues_.26_Virtual_Agent_Groups 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.
 
This list is the minimal list - it contains only statistics which are required for current version of UI.

Latest revision as of 14:54, October 26, 2021

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 Web Services and Applications Deployment Guide.

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

[+] Sample statistics.yaml file

This page was last edited on October 26, 2021, at 14:54.
Comments or questions about this documentation? Contact us for support!