Call Center Statistics¶

Instance Statistics Reporting¶

Retrieve configuration¶

GET /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/services/call_centers/(string: call_center_name)/instance_statistics_reporting/¶

Request to get the call center statistics reporting settings.

Example request:

GET /api/v1/tenants/foo/groups/foogroup/services/call_centers/APIOTestCCBasic@sip.netaxis.be/instance_statistics_reporting/ HTTP/1.1
Host: example.com

Example response:

HTTP/1.1 200 OK

{
   "generateDailyReport": false,
   "collectionPeriodMinutes": 30
}

Response JSON Object:

generateDailyReport (boolean) – Status of generate daily report.
collectionPeriodMinutes (integer) – Value of collection period minutes.
reportingEmailAddress1 (string) – Reporting email address 1.
reportingEmailAddress2 (string) – Reporting email address 2.
statisticsSource (string) – The call center statistics source.

Status Codes:

200 OK –

Update configuration¶

PUT /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/services/call_centers/(string: call_center_name)/instance_statistics_reporting/¶

Update the Call Center statistics reporting frequency and destination.

Example request:

PUT /api/v1/tenants/foo/groups/foogroup/services/call_centers/APIOTestCCPremium@sip.netaxis.be/instance_statistics_reporting/ HTTP/1.1
Host: example.com

{
   "generateDailyReport": false,
   "collectionPeriodMinutes": 30,
   "reportingEmailAddress1": "apio_test_1@netaxis.be",
   "reportingEmailAddress2": "apio_test_2@netaxis.be"
}

Request JSON Object:

generateDailyReport (boolean) – Status of generate daily report.
collectionPeriodMinutes (integer) – Value of collection period minutes.
reportingEmailAddress1 (string) – Reporting email address 1. An empty string will delete the value.
reportingEmailAddress2 (string) – Reporting email address 2. An empty string will delete the value.

Response JSON Object:

statisticsSource (string) – The call center statistics source.

Example response:

Response:

Similar to GET instance method response.

Status Codes:

200 OK – instance updated

Statistics¶

Retrieve queue and agent statistics of a call center¶

GET /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/services/call_centers/(string: call_center_name)/statistics/¶

Retrieve queue and agent statistics of a call center.

Authorization rights: minimum Group Admin.

Example request:

GET /api/v1/tenants/footenant/groups/foogroup/services/call_centers/APIOTestCallCenterP@sip.netaxis.be/statistics/ HTTP/1.1
Host: example.com

{
   "statisticsRange": {
      "start": "2021-01-01T00:00:00+01:00",
      "end": "2021-03-01T00:00:00+01:00"
   }
}

Request JSON Object:

statisticsRange (object) – (Required) The statistics time range. See Group call center statistics range attributes.

Example response:

HTTP/1.1 200 OK
Content-Type: "application/json"

{
   "statisticsRange": {
      "start": "2021-01-01T00:00:00+01:00",
      "end": "2021-03-01T00:00:00+01:00"
   },
   "queueStatistics": {
      "busyOverflows": 0,
      "callsAnswered": 0,
      "callsAbandoned": 0,
      "callsTransferred": 0,
      "callsTimedout": 0,
      "averageAgentsTalking": 0.0,
      "averageAgentsStaffed": 0.0,
      "averageWaitSeconds": 0,
      "averageAbandonmentSeconds": 0
   },
   "agentStatistics": [
      {
          "agentUserId": "ApioUserTest1@sip.netaxis.be",
          "agentDisplayNames": {
              "lastName": "Test1",
              "firstName": "Test1"
          },
          "available": true,
          "statistics": {
              "callsHandled": 0,
              "callsUnanswered": 0,
              "averageCallSeconds": 0,
              "totalTalkSeconds": 0,
              "totalStaffedSeconds": 0
          }
      },
      {
          "agentUserId": "ApioUserTest2@sip.netaxis.be",
          "agentDisplayNames": {
              "lastName": "Test2",
              "firstName": "Test2"
          },
          "available": true,
          "statistics": {
              "callsHandled": 0,
              "callsUnanswered": 0,
              "averageCallSeconds": 0,
              "totalTalkSeconds": 0,
              "totalStaffedSeconds": 0
          }
      }
   ]
}

Response JSON Object:

statisticsRange (object) – The statistics time range. See Group call center statistics range attributes.
queueStatistics (object) – The queue statistics. See Group call center queue statistics attributes.
agentStatistics (object) – List of statistics for each agent. See Group call center agent statistics attributes.

Status Codes:

200 OK – OK
400 Bad Request – Bad request due to invalid parameters, with possible sub-error codes:

2: INVALID_PARAMETERS, “The format of start date or end date is invalid.”
2: INVALID_PARAMETERS, “Start date or end date in the future”
2: INVALID_PARAMETERS, “End date can not be earlier than start date.”