Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This guide provides advice for upgrading from the deprecates retired V0 - Statistics API (deprecated) of the Insight Stats API. The guide includes each of the deprecated retired endpoints in Statistics API V0 and describes how to retrieve equivalent data using endpoints in the Insights Stats API.

Panel
borderColor#eeeeee
bgColorwhite
titleColorwhite
borderWidth1
titleBGColor#7ec9f4#0276D5
borderStylesolid
titleIn this page

Table of Contents

GET v0/{accountKey}/statistics/agentstates (

...

RETIRED)

The GET /agentstates endpoint currently returns returned the following response:

Code Block
languagejs
themeMidnight
{
  "count":2,
  "stats":[
  {
    "agentId":"10955",
    "groupId":"",
    "stateChangedAt":"2020-02-12T15:06:07Z",
    "state":"Ready",
    "duration":"00:00:09"
  },
  {
    "agentId":"10955",
    "groupId":"44311",
    "stateChangedAt":"2020-02-12T15:06:16Z",
    "state":"Busy Inbound",
    "duration":"00:00:12",
    "callGuid":"0148e4d3-684f-b8b7-e2ba-9014639797f1"
  }]
}

...

The only parameter that GET /agent-activities does not return is groupId. Use the User Admin API to get group data for users (agents).

GET v0/{accountKey}/statistics/outboundcalls (

...

RETIRED)

The GET /outboundcalls endpoint currently returns returned the following response:

Code Block
languagejs
themeMidnight
{
    "count": 1,
    "calls": [
        {
            "callGuid": "017118a8-d22f-a346-0cc7-292a629ebc5c",
            "callStartedAt": "2020-03-26T21:04:33Z",
            "state": "Make Call State: Connect",
            "agentId": "1",
            "destination": "441256636451",
            "ringDuration": "00:00:04",
            "duration": "00:00:09"
        }
    ]
}

...

Code Block
languagejs
themeMidnight
{
  "status": "Completed",
  "medium": "Phone",
  "mediumManager": "CC",
  "start": "2020-03-26T21:04:11.710Z",
  "guid": "017118a8-d22f-a346-0cc7-292a629ebc5c",
  "conversationGuid": "a6dcf0a9-31be-4876-9b49-74b01569ae84",
  "duration": 22266,
  "direction": "Outbound",
  "serviceName": null,
  "connectTo": "441256636451",
  "connectFrom": "02034631288",
  "interactionPlanMapping": {
    "addressName": null,
    "mappingName": null,
    "interactionPlanName": null
  },
  "channels": [
    {
      "guid": "017118a8-d22f-a346-0cc7-292a629ebc5c",
      "offset": 0,
      "duration": 22266,
      "endReason": "Released",
      "party": {
        "id": "1",
        "role": "Agent",
        "touchpoint": "07970303957"
      },
      "events": [
        {
          "type": "Ringing",
          "offset": 0,
          "name": null,
          "duration": 6958,
          "properties": null
        },
        {
          "type": "Connected",
          "offset": 6958,
          "name": null,
          "duration": 13300,
          "properties": null
        },
        {
          "type": "CallRecording",
          "offset": 10481,
          "name": null,
          "duration": 9777,
          "properties": null
        },
        {
          "type": "Wrap",
          "offset": 20258,
          "name": null,
          "duration": 2008,
          "properties": null
        }
      ]
    },
    {
      "guid": "b43c5dbe-562f-485a-942c-312813cb8595",
      "offset": 6980,
      "duration": 13478,
      "endReason": "Released",
      "party": {
        "id": null,
        "role": "External",
        "touchpoint": "441256636451"
      },
      "events": [
        {
          "type": "Ringing",
          "offset": 6980,
          "name": null,
          "duration": 3489,
          "properties": null
        },
        {
          "type": "Connected",
          "offset": 10469,
          "name": null,
          "duration": 9989,
          "properties": null
        },
        {
          "type": "CallRecording",
          "offset": 10481,
          "name": null,
          "duration": 9977,
          "properties": null
        }
      ]
    }
  ]
}

GET v0/{accountKey}/statistics/inboundcalls (

...

RETIRED)

The GET /inboundcalls endpoint currently returns returned the following response:

Code Block
languagejs
themeMidnight
{
    "count": 14,
    "calls": [
        {
            "connectedTo": "02034631288",
            "serviceName": "Line 88",
            "callGuid": "0171151a-c889-4656-b227-28e0266bbb66",
            "origin": "01256636451",
            "stateChangedAt": "2020-03-26T21:25:08Z",
            "sequence": 10,
            "appletName": "Line 88 UCD",
            "event": "ACDDelivery",
            "state": "Transfer State: Connected",
            "ringDuration": "00:00:06",
            "duration": "00:00:09",
            "additionalParameters": {
                "agent Id": "1",
                "group Id": "",
                "agent Phone": "07970303957"
            }
        },
        {
            "connectedTo": "02034631288",
            "serviceName": "Line 88",
            "callGuid": "0171151a-c889-4656-b227-28e0266bbb66",
            "origin": "01256636451",
            "stateChangedAt": "2020-03-26T21:25:18Z",
            "sequence": 11,
            "appletName": "Line 88 UCD",
            "event": "End",
            "state": "Caller",
            "duration": "00:00:42"
        },
        {
            "connectedTo": "02034631288",
            "serviceName": "Line 88",
            "callGuid": "0171151a-c889-4656-b227-28e0266bbb66",
            "origin": "01256636451",
            "stateChangedAt": "2020-03-26T21:24:37Z",
            "sequence": 1,
            "appletName": "Welcome",
            "event": "NewApplet",
            "state": "",
            "ringDuration": "00:00:00",
            "duration": "00:00:00",
            "additionalParameters": {
                "applet Type": "Announcement"
            }
        },
        {
            "connectedTo": "02034631288",
            "serviceName": "Line 88",
            "callGuid": "0171151a-c889-4656-b227-28e0266bbb66",
            "origin": "01256636451",
            "stateChangedAt": "2020-03-26T21:24:37Z",
            "sequence": 2,
            "appletName": "Start Recording",
            "event": "NewApplet",
            "state": "",
            "ringDuration": "00:00:00",
            "duration": "00:00:00",
            "additionalParameters": {
                "applet Type": "CallRecording"
            }
        },
        {
            "connectedTo": "02034631288",
            "serviceName": "Line 88",
            "callGuid": "0171151a-c889-4656-b227-28e0266bbb66",
            "origin": "01256636451",
            "stateChangedAt": "2020-03-26T21:24:40Z",
            "sequence": 3,
            "appletName": "Menu",
            "event": "NewApplet",
            "state": "",
            "ringDuration": "00:00:00",
            "duration": "00:00:00",
            "additionalParameters": {
                "applet Type": "Menu"
            }
        },
        {
            "connectedTo": "02034631288",
            "serviceName": "Line 88",
            "callGuid": "0171151a-c889-4656-b227-28e0266bbb66",
            "origin": "01256636451",
            "stateChangedAt": "2020-03-26T21:24:48Z",
            "sequence": 4,
            "appletName": "set optional skill",
            "event": "NewApplet",
            "state": "",
            "ringDuration": "00:00:00",
            "duration": "00:00:00",
            "additionalParameters": {
                "applet Type": "SkillTagger"
            }
        },
        {
            "connectedTo": "02034631288",
            "serviceName": "Line 88",
            "callGuid": "0171151a-c889-4656-b227-28e0266bbb66",
            "origin": "01256636451",
            "stateChangedAt": "2020-03-26T21:24:48Z",
            "sequence": 5,
            "appletName": "Create Data Sources",
            "event": "NewApplet",
            "state": "",
            "ringDuration": "00:00:00",
            "duration": "00:00:00",
            "additionalParameters": {
                "applet Type": "SetDataSource"
            }
        },
        {
            "connectedTo": "02034631288",
            "serviceName": "Line 88",
            "callGuid": "0171151a-c889-4656-b227-28e0266bbb66",
            "origin": "01256636451",
            "stateChangedAt": "2020-03-26T21:24:48Z",
            "sequence": 6,
            "appletName": "Set Customer Name",
            "event": "NewApplet",
            "state": "",
            "ringDuration": "00:00:00",
            "duration": "00:00:00",
            "additionalParameters": {
                "applet Type": "DataRetriever"
            }
        },
        {
            "connectedTo": "02034631288",
            "serviceName": "Line 88",
            "callGuid": "0171151a-c889-4656-b227-28e0266bbb66",
            "origin": "01256636451",
            "stateChangedAt": "2020-03-26T21:24:49Z",
            "sequence": 7,
            "appletName": "Lookup Package",
            "event": "NewApplet",
            "state": "",
            "ringDuration": "00:00:00",
            "duration": "00:00:00",
            "additionalParameters": {
                "applet Type": "DataRetriever"
            }
        },
        {
            "connectedTo": "02034631288",
            "serviceName": "Line 88",
            "callGuid": "0171151a-c889-4656-b227-28e0266bbb66",
            "origin": "01256636451",
            "stateChangedAt": "2020-03-26T21:24:49Z",
            "sequence": 8,
            "appletName": "Company",
            "event": "NewApplet",
            "state": "",
            "ringDuration": "00:00:00",
            "duration": "00:00:00",
            "additionalParameters": {
                "applet Type": "DataRetriever"
            }
        },
        {
            "connectedTo": "02034631288",
            "serviceName": "Line 88",
            "callGuid": "0171151a-c889-4656-b227-28e0266bbb66",
            "origin": "01256636451",
            "stateChangedAt": "2020-03-26T21:24:50Z",
            "sequence": 9,
            "appletName": "Full name",
            "event": "NewApplet",
            "state": "",
            "ringDuration": "00:00:00",
            "duration": "00:00:00",
            "additionalParameters": {
                "applet Type": "SetDataSource"
            }
        },
        {
            "connectedTo": "02034631288",
            "serviceName": "Line 88",
            "callGuid": "0171151a-c889-4656-b227-28e0266bbb66",
            "origin": "01256636451",
            "stateChangedAt": "2020-03-26T21:24:50Z",
            "sequence": 10,
            "appletName": "Line 88 UCD",
            "event": "NewApplet",
            "state": "",
            "ringDuration": "00:00:00",
            "duration": "00:00:00",
            "additionalParameters": {
                "applet Type": "ACD"
            }
        },
        {
            "connectedTo": "02034631288",
            "serviceName": "Line 88",
            "callGuid": "0171151a-c889-4656-b227-28e0266bbb66",
            "origin": "01256636451",
            "stateChangedAt": "2020-03-26T21:24:51Z",
            "sequence": 10,
            "appletName": "Line 88 UCD",
            "event": "Queue",
            "state": "Queue State: Success",
            "duration": "00:00:12",
            "additionalParameters": {
                "queue Reason": "ACD",
                "iteration": ""
            }
        },
        {
            "connectedTo": "02034631288",
            "serviceName": "Line 88",
            "callGuid": "0171151a-c889-4656-b227-28e0266bbb66",
            "origin": "01256636451",
            "stateChangedAt": "2020-03-26T21:24:37Z",
            "sequence": 0,
            "appletName": "Welcome",
            "event": "Start",
            "state": ""
        }
    ]
}

...