API for returning System Statistics.
GET /Stats/AccountsByGroup
Returns pie chart data that represents the number of accounts belonging to each account group.
See Accounts By Group Pie Chart.
GET /Stats/AccountGroupsByStatus
Returns tabular data for the number of accounts in each account group by account status (Provisioned, In Transit, In Stock, etc.).
See Account Groups By Status.
GET /Stats/InUseByModule
Returns tabular data for the number of sessions in use by module.
See In Use By Module Statistics.
GET /Stats/InUse/TotalCallers
Returns total number of callers.
See Total Callers.
GET /Stats/InUse/CallersByAccountGroup
Returns line chart data that represents the current number of active callers by account group.
See Total Callers By Account Group Line Chart.
For additional details on usage, please see the Notes section below regarding Realtime Chart Data.
GET /Stats/Nodes/{NodeName}
Returns doughnut chart data for a variety of node statistics for the specified Node name.
See Getting a List of Node Names.
See Node Statistics.
Looking up a Resource (single objects, lists and tabular data)
Realtime Chart Data
For realtime charts, the API will return a snapshot of the data for the current moment. Therefore, no predefined Categories (which represent the X axis elements) will be returned.
Therefore, the recommended usage is to store the current time when first displaying the graph. Whenever the graph is updated by getting the next snapshot (e.g., every N seconds), you can represent the next X axis element as (StartTime + (Number of X axis elements * Interval Seconds) to get a uniform list of chart categories as they are displayed.
E.g., for 10 second intervals, if the time starts at 9:03 am, the categories might be:
(9:03, 9:13, 9:23, 933, etc.)
To get a list of node names to select for displaying the statistics, you can MUST call the following URL with the NodeType parameter set to 1.
GET ivrapi/System/Nodes?NodeType=1
NOTE: You can use the Name as the parameter to GET /Stats/Nodes/{NodeName} and can ignore the value of the Id returned in this list as it just represents the Node Type.
{
"status": "success",
"message": "",
"data":
[
{
"Id": 1,
"Name": "SIPIVR02"
},
{
"Id": 1,
"Name": "SIPIVR01"
}
]
}
GET ivrapi/Stats/AccountsByGroup
{
"status": "success",
"message": "",
"data": {
"Title": "Accounts By Group",
"Series":
[
{
"Category": "Demo",
"Value": 3
},
{
"Category": "SYSTEM",
"Value": 13
},
{
"Category": "Test",
"Value": 137
}
]
}
}
GET ivrapi/Stats/AccountGroupsByStatus
{
"status": "success",
"message": "",
"data":
[
{
"columns":
[
{
"caption": "Account Group",
"field": "ACCOUNT_GROUP",
"type": 1,
"visible": true,
"width": 21
},
{
"caption": "Total",
"field": "TOTAL",
"type": 3,
"visible": true,
"width": 8
},
{
"caption": "Provisioned",
"field": "PROVISIONED",
"type": 3,
"visible": true,
"width": 14
},
{
"caption": "In Transit",
"field": "IN_TRANSIT",
"type": 3,
"visible": true,
"width": 13
},
{
"caption": "In Stock",
"field": "IN_STOCK",
"type": 3,
"visible": true,
"width": 11
},
{
"caption": "Active",
"field": "ACTIVE",
"type": 3,
"visible": true,
"width": 9
},
{
"caption": "Activated",
"field": "ACTIVATED",
"type": 3,
"visible": true,
"width": 12
},
{
"caption": "Expired",
"field": "EXPIRED",
"type": 3,
"visible": true,
"width": 10
},
{
"caption": "Suspended",
"field": "SUSPENDED",
"type": 3,
"visible": true,
"width": 12
},
{
"caption": "Deactivated",
"field": "DEACTIVATED",
"type": 3,
"visible": true,
"width": 14
}
],
"rows":
[
{
"ACCOUNT_GROUP": "Demo",
"TOTAL": 3,
"PROVISIONED": 2,
"IN_TRANSIT": 0,
"IN_STOCK": 0,
"ACTIVE": 0,
"ACTIVATED": 1,
"EXPIRED": 0,
"SUSPENDED": 0,
"DEACTIVATED": 0
},
{
"ACCOUNT_GROUP": "SYSTEM",
"TOTAL": 13,
"PROVISIONED": 2,
"IN_TRANSIT": 0,
"IN_STOCK": 0,
"ACTIVE": 2,
"ACTIVATED": 0,
"EXPIRED": 0,
"SUSPENDED": 9,
"DEACTIVATED": 0
},
{
"ACCOUNT_GROUP": "Test",
"TOTAL": 137,
"PROVISIONED": 114,
"IN_TRANSIT": 0,
"IN_STOCK": 0,
"ACTIVE": 19,
"ACTIVATED": 4,
"EXPIRED": 0,
"SUSPENDED": 0,
"DEACTIVATED": 0
}
]
}
]
}
GET ivrapi/Stats/InUseByModule
{
"status": "success",
"message": "",
"data":
[
{
"columns":
[
{
"caption": "Account Group",
"field": "ACCOUNT_GROUP",
"type": 1,
"visible": true,
"width": 25
},
{
"caption": "Debit Module",
"field": "DEBIT_MODULE",
"type": 3,
"visible": true,
"width": 15
},
{
"caption": "Tandem Module",
"field": "TANDEM_MODULE",
"type": 3,
"visible": true,
"width": 16
},
{
"caption": "Termination Module",
"field": "TERMINATION_MODULE",
"type": 3,
"visible": true,
"width": 21
}
],
"rows":
[
{
"ACCOUNT_GROUP": "Calling Plan A",
"DEBIT_MODULE": 1,
"TANDEM_MODULE": 2,
"TERMINATION_MODULE": 0
},
{
"ACCOUNT_GROUP": "Calling Plan B",
"DEBIT_MODULE": 2,
"TANDEM_MODULE": 0,
"TERMINATION_MODULE": 0
},
{
"ACCOUNT_GROUP": "Calling Plan C",
"DEBIT_MODULE": 1,
"TANDEM_MODULE": 0,
"TERMINATION_MODULE": 3
},
{
"ACCOUNT_GROUP": "Calling Plan D",
"DEBIT_MODULE": 0,
"TANDEM_MODULE": 0,
"TERMINATION_MODULE": 1
}
]
}
]
}
GET ivrapi/Stats/inuse/TotalCallers
{
"status": "success",
"message": "",
"data": {
"TotalCallers": 15
}
}
GET ivrapi/Stats/inuse/CallersByAccountGroup
{
"status": "success",
"message": "",
"data": {
"Title": "Callers by Account Group",
"Categories": [],
"Series":
[
{
"Name": "Calling Plan A",
"Data":
[
108
]
},
{
"Name": "Calling Plan B",
"Data":
[
108
]
},
{
"Name": "Calling Plan C",
"Data":
[
188
]
},
{
"Name": "Calling Plan D",
"Data":
[
1
]
}
]
}
}
GET ivrapi/Stats/nodes/SIPIVR01
{
"status": "success",
"message": "",
"data": {
"InboundRequests": {
"Title": "Inbound",
"Series":
[
{
"Category": "Inbound Calls",
"Value": 584
},
{
"Category": "Inbound Calls (Rejected)",
"Value": 78
},
{
"Category": "Inbound Trunking Calls",
"Value": 0
},
{
"Category": "Inbound Trunking Calls (Rejected)",
"Value": 0
},
{
"Category": "MPS Requests",
"Value": 38421
},
{
"Category": "Data Requests",
"Value": 73904
},
{
"Category": "Data Requests (Rejected)",
"Value": 48179
}
]
},
"OutboundRequests": {
"Title": "Outbound",
"Series":
[
{
"Category": "Outbound Calls",
"Value": 121
},
{
"Category": "Outbound Calls (Incomplete)",
"Value": 24258
},
{
"Category": "Outbound Trunking Calls",
"Value": 0
},
{
"Category": "Outbound Trunking Calls (Incomplete)",
"Value": 0
}
]
},
"InboundMinutes": {
"Title": "Inbound Minutes",
"Series":
[
{
"Category": "Inbound Minutes",
"Value": 2311496
},
{
"Category": "Inbound Trunking Minutes",
"Value": 0
}
]
},
"OutboundMinutes": {
"Title": "Outbound Minutes",
"Series":
[
{
"Category": "Outbound Minutes",
"Value": 16
},
{
"Category": "Outbound Trunking Minutes",
"Value": 0
}
]
},
"PeakUsers": {
"Title": "Peak",
"Series":
[
{
"Category": "Callers",
"Value": 1990
},
{
"Category": "Data",
"Value": 1000
},
{
"Category": "Trunking",
"Value": 0
},
{
"Category": "MPS",
"Value": 1300
}
]
}
}
}