Queue Reporting

QueueSummaryBrowse

Returns summary information about a queue or queues over a specified period of time

Authentication & Authorization

Authentication Authorization
Authenticated Session Queue Supervisor

Request Parameters

Required Parameters Description
Action “QueueSummaryBrowse”
SessionId Authenticated Session identifier.
OrganizationId A positive integer which references a unique organization

 

One and Only One of the Following Optional Parameters Default Description
MonthOffset 0 A month offset into the history. 0 = current month, -1 = last month, -2 = two months ago, …
StartDateTime & EndDateTime NA GNU DateTime range; StartDateTime <= DateTime < EndDateTime

  

Optional Parameters Default Description
OrderBy AppId AppId | OrganizationId
Limit 20 The maximum number of records to return.
Offset 0 The offset of the first record to return. The offset of the initial record is 0 (not 1).
CalcFound true Calculate how many records there would be in the result set, disregarding any Limit parameter.
OutputFormat xml xml | csv
AppId  NA The App Id of the queue to be reported on; will report on them all if left out

Sample Request

cURL
1
2
3
4
curl -X POST \
--data \
'Action=QueueSummaryBrowse&SessionId=nlibgopjksp2bel1ai22lp37l4&OrganizationId=25018&StartDateTime=2016-07-06T13:35:13%2B00:00&EndDateTime=2016-07-13T21:02:19%2B00:00' \
https://api.onsip.com/api
JavaScript
1
2
3
4
5
6
7
var data = new FormData();
data.append('Action', 'QueueSummaryBrowse');
data.append('SessionId', 'nlibgopjksp2bel1ai22lp37l4');
data.append('OrganizationId', '25018');
data.append('StartDateTime', '2016-07-06T13:35:13%2B00:00');
data.append('EndDateTime', '2016-07-13T21:02:19%2B00:00');
var xhr = new XMLHttpRequest(); xhr.open('POST', 'https://api.onsip.com/api', true); xhr.onload = function () { console.log(this.responseText); } xhr.send(data);

Sample Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
<Response xmlns="http://www.jnctn.net/ns/rest/2006-01">
  <Context>
    <Action>
      <IsCompleted>true</IsCompleted>
    </Action>
    <Request>
      <IsValid>true</IsValid>
      <DateTime>2017-02-02T19:00:01+00:00</DateTime>
      <Duration>34</Duration>
      <Parameters>
        <Parameter>
          <Name>Action</Name>
          <Value>QueueSummaryBrowse</Value>
        </Parameter>
        <Parameter>
          <Name>SessionId</Name>
          <Value>nlibgopjksp2bel1ai22lp37l4</Value>
         </Parameter>
        <Parameter>
          <Name>OrganizationId</Name>
          <Value>25018</Value>
        </Parameter>
        <Parameter>
          <Name>StartDateTime</Name>
          <Value>2016-07-06T13:35:13+00:00</Value>
        </Parameter>
        <Parameter>
          <Name>EndDateTime</Name>
          <Value>2016-07-13T21:02:19+00:00</Value>
        </Parameter>
        <Parameter>
          <Name>Limit</Name>
          <Value>20</Value>
        </Parameter>
      </Parameters>
    </Request>
    <Session>
      <IsEstablished>true</IsEstablished>
      <SessionId>1q7pqrn988it4eoel67jopi8r2</SessionId>
      <UserId>152255</UserId>
      <Roles>
        <Role>
          <Name>Account Admin</Name>
        </Role>
      </Roles>
    </Session>
  </Context>
  <Result>
    <QueueSummaryBrowse>
      <QueueSummaries Limit="20">
        <QueueSummary>
          <AppId>1</AppId>
          <CallsInQueue>4</CallsInQueue>
          <AvgWaitDuration>7.0000</AvgWaitDuration>
          <MaxWaitDuration>13</MaxWaitDuration>
          <CallsAnswered>2</CallsAnswered>
          <AvgAnsweredCallDuration>20.2500</AvgAnsweredCallDuration>
          <CallsAbandoned>1</CallsAbandoned>
          <AvgAbandonWaitDuration>2.0000</AvgAbandonWaitDuration>
          <CallsManuallyFailedOver>0</CallsManuallyFailedOver>
          <CallWithMaxWaitDuration>2016-07-13 03:14:12</CallWithMaxWaitDuration>
          <MostAbandonedTimeOfDay>3</MostAbandonedTimeOfDay>
          <BusiestTimeOfDay>3</BusiestTimeOfDay>
          <QueueFailureAbandonedCalls>0</QueueFailureAbandonedCalls>
          <QueueFailureAnsweredCalls>0</QueueFailureAnsweredCalls>
          <MaxCallersFailoverCalls>0</MaxCallersFailoverCalls>
          <MaxCallersRejectCalls>0</MaxCallersRejectCalls>
          <MaxWaitCalls>0</MaxWaitCalls>
          <NoAgentFailoverCalls>1</NoAgentFailoverCalls>
          <NoAgentRejectCalls>0</NoAgentRejectCalls>
        </QueueSummary>
      </QueueSummaries>
    </QueueSummaryBrowse>
  </Result>
</Response>

QueueAgentSummaryBrowse

Returns summary information about the agents in a queue over a specified period of time

Authentication & Authorization

Authentication Authorization
Authenticated Session Queue Supervisor

Request Parameters

Required Parameters Description
Action “QueueAgentSummaryBrowse”
SessionId Authenticated Session identifier.
OrganizationId A positive integer which references a unique organization
AppId  The App Id of the queue to be reported on

 

One and Only One of the Following Optional Parameters Default Description
MonthOffset 0 A month offset into the history. 0 = current month, -1 = last month, -2 = two months ago, …
StartDateTime & EndDateTime NA GNU DateTime range; StartDateTime <= DateTime < EndDateTime

  

Optional Parameters Default Description
OrderBy AppId AppId | OrganizationId
Limit 20 The maximum number of records to return.
Offset 0 The offset of the first record to return. The offset of the initial record is 0 (not 1).
CalcFound true Calculate how many records there would be in the result set, disregarding any Limit parameter.
OutputFormat xml xml | csv

Sample Request

cURL
1
2
3
4
curl -X POST \
--data \
'Action=QueueAgentSummaryBrowse&SessionId=nlibgopjksp2bel1ai22lp37l4&OrganizationId=25018&AppId=1&StartDateTime=2017-01-29T13:35:13%2B00:00&EndDateTime=2017-02-01T21:02:19%2B00:00 \
https://api.onsip.com/api
JavaScript
1
2
3
4
5
6
7
8
var data = new FormData();
data.append('Action', 'QueueAgentSummaryBrowse');
data.append('SessionId', 'nlibgopjksp2bel1ai22lp37l4');
data.append('OrganizationId', '25018');
data.append('AppId', '1');
data.append('StartDateTime', '2017-01-29T13:35:13%2B00:00');
data.append('EndDateTime', '2017-02-01T21:02:19%2B00:00');
var xhr = new XMLHttpRequest(); xhr.open('POST', 'https://api.onsip.com/api', true); xhr.onload = function () { console.log(this.responseText); } xhr.send(data);

Sample Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
<Response xmlns="http://www.jnctn.net/ns/rest/2006-01">
  <Context>
    <Action>
      <IsCompleted>true</IsCompleted>
    </Action>
    <Request>
      <IsValid>true</IsValid>
      <DateTime>2017-02-02T19:07:39+00:00</DateTime>
      <Duration>31</Duration>
      <Parameters>
        <Parameter>
          <Name>Action</Name>
          <Value>QueueAgentSummaryBrowse</Value>
        </Parameter>
        <Parameter>
          <Name>SessionId</Name>
          <Value>1q7pqrn988it4eoel67jopi8r2</Value>
        </Parameter>
        <Parameter>
          <Name>OrganizationId</Name>
          <Value>25018</Value>
        </Parameter>
        <Parameter>
          <Name>AppId</Name>
          <Value>1</Value>
        </Parameter>
        <Parameter>
          <Name>StartDateTime</Name>
          <Value>2017-01-29T13:35:13+00:00</Value>
        </Parameter>
        <Parameter>
          <Name>EndDateTime</Name>
          <Value>2017-02-01T21:02:19+00:00</Value>
        </Parameter>
        <Parameter>
          <Name>Limit</Name>
          <Value>20</Value>
        </Parameter>
      </Parameters>
    </Request>
    <Session>
      <IsEstablished>true</IsEstablished>
      <SessionId>1q7pqrn988it4eoel67jopi8r2</SessionId>
      <UserId>152255</UserId>
      <Roles>
        <Role>
          <Name>Account Admin</Name>
        </Role>
      </Roles>
    </Session>
  </Context>
  <Result>
    <QueueAgentSummaryBrowse>
      <QueueAgentSummaries Limit="20">
        <QueueAgentSummary>
          <AgentAddress>john@example.onsip.com</AgentAddress>
          <AgentName>John Everyman</AgentName>
          <LoginDuration>833</LoginDuration>
          <CallsAnswered>1</CallsAnswered>
          <AvgCallLength>11.0000</AvgCallLength>
          <TimeOnCalls>11</TimeOnCalls>
          <TimeIdle>822</TimeIdle>
          <TimeOnHold>0</TimeOnHold>
        </QueueAgentSummary>
        <QueueAgentSummary>
          <AgentAddress>tom@example.onsip.com</AgentAddress>
          <AgentName>tom</AgentName>
          <LoginDuration>286024</LoginDuration>
          <CallsAnswered>3</CallsAnswered>
          <AvgCallLength>21.6667</AvgCallLength>
          <TimeOnCalls>65</TimeOnCalls>
          <TimeIdle>285959</TimeIdle>
          <TimeOnHold>0</TimeOnHold>
        </QueueAgentSummary>
        <QueueAgentSummary>
          <AgentAddress>zach@example.onsip.com</AgentAddress>
          <AgentName>zach</AgentName>
          <LoginDuration>819</LoginDuration>
          <CallsAnswered>2</CallsAnswered>
          <AvgCallLength>41.5000</AvgCallLength>
          <TimeOnCalls>83</TimeOnCalls>
          <TimeIdle>736</TimeIdle>
          <TimeOnHold>0</TimeOnHold>
        </QueueAgentSummary>
      </QueueAgentSummaries>
    </QueueAgentSummaryBrowse>
  </Result>
</Response>

Topics: Developer Docs