Tech_Insights Monitoring API

The Query API always returns information as a JSON payload, of one of two forms. When the data returned can only be a single object, then exactly that JSON object is returned.

When the data contains multiple objects, then the return is a header

{ "totalCount": <number>, "totalPages": <number>, "pageNumber": <number>, "pageSize": <number>, "limitReached": <boolean>, "content": [ { ... }, ... ] }

The common header section was discussed in The Tech Insights Monitoring Query API - Information Queries - this document contains details of the content array or JSON object for each REST query type.

Get Calls	Array of: { "day": "YYYY-MM-DD", "source": "<source caller>", "target": "<call target>", "time": "YYYY-MM-DDTHH:mm:ssZ", "bitrate": <number>, "presentation": "<id">, "protocol": "<protocol name>", "quality": "<GOOD\|FAIR\|BAD\|UNKNOWN>", "duration": <number of seconds, "org_id": <organisation id>, "call_id": "<string>", "start_time": "YYYY-MM-DDTHH:mm:ssZ" "end_time": "YYYY-MM-DDTHH:mm:ssZ", "data_source": "<data source>", "system_id": <number>, "system_name": "<string>", "media_routed": <boolean>, "quality_details_updated": <null \| YYYY-MM-DDTHH:mm:ss>, "call_records_updated": "YYYY-MM-DDTHH:mm:ssZ", "endpoint_id": <number \| null>, "endpoint_name": <string \| null> "meeting_start_time":<null \| YYYY-MM-DDTHH:mm:ss>, "meeting_id": <null \| string>, "meeting_name": <null \| string>, "trunk_id": < null \| trunk_id>, "trunk_name": <null \| string> }, ...
Get Call Details	Instance of: { "day": "YYYY-MM-DD", "source": "<source caller>", "target": "<call target>", "time": "YYYY-MM-DDTHH:mm:ssZ", "bitrate": <number>, "presentation": "<id">, "protocol": "<protocol name>", "quality": "<GOOD\|FAIR\|BAD\|UNKNOWN>", "duration": <number of seconds, "org_id": <organisation id>, "call_id": "<string>", "start_time": "YYYY-MM-DDTHH:mm:ssZ" "end_time": "YYYY-MM-DDTHH:mm:ssZ", "data_source": "<data source>", "system_id": <number>, "system_name": "<string>", "media_routed": <boolean>, "quality_details_updated": <null \| YYYY-MM-DDTHH:mm:ss>, "call_records_updated": "YYYY-MM-DDTHH:mm:ssZ", "endpoint_id": <number \| null>, "endpoint_name": <string \| null> "meeting_start_time":<null \| YYYY-MM-DDTHH:mm:ss>, "meeting_id": <null \| string>, "meeting_name": <null \| string>, "trunk_id": < null \| trunk_id>, "trunk_name": <null \| string> }
Get Call Quality Details	An Array of arrays containing timestamp/value pairs representing data specified in the categories and metrics
Get Call Records	Return the call data record information for this call,, or a 404 if not found. A typical set of call records for a CUCM handled call will have a CDR (Call Data Record) and two CMR (Call Management Records). [ { "org_id" : 1, "call_id" : "2-374880", "start_time" : "2018-11-19T16:06:00Z", "record_id" : "41780986", "record_type" : "CUCM_CMR", "system_id" : 1, "system_name" : "Cisco Call Manager", "time" : "2018-11-19T17:12:00Z", "original_file_name" : "298973122_1_1_CucmCdrLog.gz", "values" : { "callIdentifier" : "41780986", "cdrRecordType" : "2", "dateTimeStamp" : "1542645741", "deviceName" : "SEP001234567890", "directoryNum" : "1234", "directoryNumPartition" : "PT_7TS_Line1", "duration" : "", "globalCallID_callId" : "374880", "globalCallID_callManagerId" : "2", "globalCallId_ClusterID" : "l02planncucm", "jitter" : "0", "latency" : "0", "nodeId" : "2", "numberOctetsReceived" : "18759524", "numberOctetsSent" : "18762060", "numberPacketsLost" : "109166", "numberPacketsReceived" : "109067", "numberPacketsSent" : "109167", "numberVideoOctetsReceived" : "", "numberVideoOctetsReceived_channel2" : "", "numberVideoOctetsSent" : "", "numberVideoOctetsSent_channel2" : "", "numberVideoPacketsLost" : "", "numberVideoPacketsLost_channel2" : "", "numberVideoPacketsReceived" : "", "numberVideoPacketsReceived_channel2" : "", "numberVideoPacketsSent" : "", "numberVideoPacketsSent_channel2" : "", "pkid" : "a0271e63-df20-4542-849c-f8e3e8751728", "varVQMetrics" : "MLQK=4.5000;MLQKav=4.4973;MLQKmn=3.8986;MLQKmx=4.5000;MLQKvr=0.95;CCR=0.0000;ICR=0.0000;ICRmx=0.0494;CS=3;SCS=1", "videoAverageJitter" : "", "videoAverageJitter_channel2" : "", "videoContentType" : "", "videoContentType_channel2" : "", "videoDuration" : "", "videoDuration_channel2" : "", "videoOneWayDelay" : "", "videoOneWayDelay_channel2" : "", "videoReceptionMetrics" : "", "videoReceptionMetrics_channel2" : "", "videoRoundTripTime" : "", "videoRoundTripTime_channel2" : "", "videoTransmissionMetrics" : "", "videoTransmissionMetrics_channel2" : "" } }, { "org_id" : 1, "call_id" : "2-374880", "start_time" : "2018-11-19T16:06:00Z", "record_id" : "41780987", "record_type" : "CUCM_CMR", "system_id" : 1, "system_name" : "Cisco Call Manager", "time" : "2018-11-19T17:12:00Z", "original_file_name" : "298973122_1_1_CucmCdrLog.gz", "values" : { "callIdentifier" : "41780987", "cdrRecordType" : "2", "dateTimeStamp" : "1542645741", "deviceName" : "SEP001234567890", "directoryNum" : "1234", "directoryNumPartition" : "PT_7TS_Line1", "duration" : "", "globalCallID_callId" : "374880", "globalCallID_callManagerId" : "2", "globalCallId_ClusterID" : "l02planncucm", "jitter" : "0", "latency" : "0", "nodeId" : "2", "numberOctetsReceived" : "18759524", "numberOctetsSent" : "18762060", "numberPacketsLost" : "109166", "numberPacketsReceived" : "109067", "numberPacketsSent" : "109167", "numberVideoOctetsReceived" : "", "numberVideoOctetsReceived_channel2" : "", "numberVideoOctetsSent" : "", "numberVideoOctetsSent_channel2" : "", "numberVideoPacketsLost" : "", "numberVideoPacketsLost_channel2" : "", "numberVideoPacketsReceived" : "", "numberVideoPacketsReceived_channel2" : "", "numberVideoPacketsSent" : "", "numberVideoPacketsSent_channel2" : "", "pkid" : "a0271e63-df20-4542-849c-f8e3e8751728", "varVQMetrics" : "MLQK=4.5000;MLQKav=4.4973;MLQKmn=3.8986;MLQKmx=4.5000;MLQKvr=0.95;CCR=0.0000;ICR=0.0000;ICRmx=0.0494;CS=3;SCS=1", "videoAverageJitter" : "", "videoAverageJitter_channel2" : "", "videoContentType" : "", "videoContentType_channel2" : "", "videoDuration" : "", "videoDuration_channel2" : "", "videoOneWayDelay" : "", "videoOneWayDelay_channel2" : "", "videoReceptionMetrics" : "", "videoReceptionMetrics_channel2" : "", "videoRoundTripTime" : "", "videoRoundTripTime_channel2" : "", "videoTransmissionMetrics" : "", "videoTransmissionMetrics_channel2" : "" } }, { "org_id" : 1, "call_id" : "2-374880", "start_time" : "2018-11-19T16:06:00Z", "record_id" : "41780986-41780987", "record_type" : "CUCM_CDR", "system_id" : 1, "system_name" : "Cisco Call Manager", "time" : "2018-11-19T17:00:00Z", "original_file_name" : "298972041_1_1_CucmCdrLog.gz", "values" : { "IncomingICID" : "", "IncomingOrigIOI" : "", "IncomingProtocolCallRef" : "", "IncomingProtocolID" : "0", "IncomingTermIOI" : "", "OutgoingICID" : "", "OutgoingOrigIOI" : "", "OutgoingProtocolCallRef" : "005FE980000100000001A0373340480A", "OutgoingProtocolID" : "1", "OutgoingTermIOI" : "", "authCodeDescription" : "", "authorizationCodeValue" : "", "authorizationLevel" : "0", "callSecuredStatus" : "0", "calledPartyPatternUsage" : "5", "callingPartyNumber" : "1234", "callingPartyNumberPartition" : "PT_7TS_Line1", "callingPartyNumber_uri" : "test@example.com", "callingPartyUnicodeLoginUserID" : "MMATUR", "cdrRecordType" : "1", "clientMatterCode" : "", "comment" : "", "currentRoutingReason" : "0", "dateTimeConnect" : "1542643560", "dateTimeDisconnect" : "1542645741", "dateTimeOrigination" : "1542643541", "destCallTerminationOnBehalfOf" : "0", "destCause_location" : "0", "destCause_value" : "0", "destConversationId" : "0", "destDTMFMethod" : "2", "destDeviceName" : "l02plappsme", "destIpAddr" : "369365002", "destIpv4v6Addr" : "10.0.0.15", "destLegIdentifier" : "41780987", "destMediaCap_Bandwidth" : "64", "destMediaCap_g723BitRate" : "0", "destMediaCap_maxFramesPerPacket" : "20", "destMediaCap_payloadCapability" : "4", "destMediaTransportAddress_IP" : "251658250", "destMediaTransportAddress_Port" : "22170", "destMobileCallDuration" : "0", "destMobileDeviceName" : "", "destNodeId" : "2", "destPrecedenceLevel" : "4", "destRSVPAudioStat" : "0", "destRSVPVideoStat" : "0", "destSpan" : "41780987", "destVideoCap_Bandwidth" : "0", "destVideoCap_Bandwidth_Channel2" : "0", "destVideoCap_Codec" : "0", "destVideoCap_Codec_Channel2" : "0", "destVideoCap_Resolution" : "0", "destVideoCap_Resolution_Channel2" : "0", "destVideoChannel_Role_Channel2" : "0", "destVideoTransportAddress_IP" : "0", "destVideoTransportAddress_IP_Channel2" : "0", "destVideoTransportAddress_Port" : "0", "destVideoTransportAddress_Port_Channel2" : "0", "duration" : "2181", "finalCalledPartyNumber" : "912345678900", "finalCalledPartyNumberPartition" : "PT_7TS_Longdistance", "finalCalledPartyNumber_uri" : "", "finalCalledPartyPattern" : "9.1[2-9]XX[2-9]XXXXXX", "finalCalledPartyUnicodeLoginUserID" : "", "finalMobileCalledPartyNumber" : "", "globalCallID_callId" : "374880", "globalCallID_callManagerId" : "2", "globalCallId_ClusterID" : "l02planncucm", "huntPilotDN" : "", "huntPilotPartition" : "", "huntPilotPattern" : "", "joinOnBehalfOf" : "0", "lastRedirectDn" : "912345678900", "lastRedirectDnPartition" : "PT_7TS_Longdistance", "lastRedirectDn_uri" : "", "lastRedirectRedirectOnBehalfOf" : "0", "lastRedirectRedirectReason" : "0", "lastRedirectingPartyPattern" : "9.1[2-9]XX[2-9]XXXXXX", "lastRedirectingRoutingReason" : "0", "mobileCallType" : "0", "mobileCallingPartyNumber" : "", "origCallTerminationOnBehalfOf" : "12", "origCalledPartyRedirectOnBehalfOf" : "0", "origCalledPartyRedirectReason" : "0", "origCause_location" : "0", "origCause_value" : "16", "origConversationId" : "0", "origDTMFMethod" : "3", "origDeviceName" : "SEP001234567890", "origIpAddr" : "739182602", "origIpv4v6Addr" : "10.8.15.44", "origLegCallIdentifier" : "41780986", "origMediaCap_Bandwidth" : "64", "origMediaCap_g723BitRate" : "0", "origMediaCap_maxFramesPerPacket" : "20", "origMediaCap_payloadCapability" : "4", "origMediaTransportAddress_IP" : "739182602", "origMediaTransportAddress_Port" : "23840", "origMobileCallDuration" : "0", "origMobileDeviceName" : "", "origNodeId" : "2", "origPrecedenceLevel" : "4", "origRSVPAudioStat" : "0", "origRSVPVideoStat" : "0", "origRoutingReason" : "0", "origSpan" : "0", "origVideoCap_Bandwidth" : "0", "origVideoCap_Bandwidth_Channel2" : "0", "origVideoCap_Codec" : "0", "origVideoCap_Codec_Channel2" : "0", "origVideoCap_Resolution" : "0", "origVideoCap_Resolution_Channel2" : "0", "origVideoChannel_Role_Channel2" : "0", "origVideoTransportAddress_IP" : "0", "origVideoTransportAddress_IP_Channel2" : "0", "origVideoTransportAddress_Port" : "0", "origVideoTransportAddress_Port_Channel2" : "0", "originalCalledPartyNumber" : "912345678900", "originalCalledPartyNumberPartition" : "PT_7TS_Longdistance", "originalCalledPartyNumber_uri" : "", "originalCalledPartyPattern" : "9.1[2-9]XX[2-9]XXXXXX", "outpulsedCalledPartyNumber" : "+18412347615", "outpulsedCallingPartyNumber" : "", "outpulsedLastRedirectingNumber" : "", "outpulsedOriginalCalledPartyNumber" : "", "pkid" : "cb3dd888-d687-4221-b933-58e2fac5e7de", "totalWaitTimeInQueue" : "0", "wasCallQueued" : "0" } } ]
Get Endpoints	Any array of endpoints [ { "time": "2020-03-19T16:28:51.227Z", "name": "Fred's Room", "manufacturer": null, "model": "Cisco Webex Room Kit", "status": "None", "camera": "UNKNOWN", "display": "UNKNOWN", "microphone": "UNKNOWN", "tags": "LastSupport20191231,null,test", "firmware": "ce9.12.0.299bdb9cfab", "deleted": false, "org_id": 1, "endpoint_id": 234567, "direct_number": null, "host_address": "10.200.30.102", "sip_address": "fred@myco.com.ciscospark.com", "touch_panel": "UNKNOWN", "epm_status": "NoMessages", "epm_reason": null, "peripherals": [ "camera-1", "display-1", "mic-1", "mic-2", "mic-3" ] }, { "time": "2020-03-19T16:33:52.766Z", "name": "Eric's Room", "manufacturer": null, "model": "Cisco Webex Board 55", "status": "Available", "camera": "Connected=1 \| Not Connected=none", "display": "Connected=1 \| Not Connected=none", "microphone": "Muted=false \| Connected=none \| Not Connected=none", "tags": null, "firmware": "ce9.12.1.c97d0c44939", "deleted": false, "org_id": 1, "endpoint_id": 123456, "direct_number": null, "host_address": "10.100.40.189", "sip_address": "eric@myco.com.ciscospark.com", "touch_panel": "Connected=none \| Not Connected=none", "epm_status": "OK", "epm_reason": null, "peripherals": [ "camera-1", "display-1" ] },
Get Endpoint Details	Exactly one endpoint object, as above
Delete a Peripheral from an Endpoint	Remove a specified peripheral from an endpoint where peripheral is taken from the endpoint details. A 200 is returned on success
Get Systems	Returns an array of infrastructure objects [ { "time" : "YYYY-MM-DDTHH:mm:SS.sssZ", "name" : "name-0", "manufacturer" : "manufacturer-0", "type" : "UNKNOWN", "status" : "None", "deleted" : false, "reason" : null, "org_id" : 1, "system_id" : 0, "audio_port_available" : null, "audio_port_used" : null, "audio_port_used_percent" : null, "calls_available" : null, "calls" : 0.0, "calls_used_percent" : null, "meetings" : null, "crc_port_available" : null, "crc_port_used" : null, "crc_port_used_percent" : null, "media_load_percent" : null, "screens" : null, "screens_available" : null, "screens_used_percent" : null, "hd_port_licenses_used" : null, "hd_port_licenses_used_percent" : null, "nontraversal_calls" : null, "nontraversal_calls_used_percent" : null, "participants" : null, "registered_available" : null, "registered" : null, "registered_used_percent" : null, "hardware" : "server0", "traversal_calls" : null, "traversal_calls_used_percent" : null, "video_port_available" : null, "video_port_used" : null, "video_port_used_percent" : null }, { ... } ]
Get Trunks	Returns an array of trunk objects [ { "time": "YYYY-MM-DDTHH:mm:SS.sssZ", "name": "<trunk name string>", "protocol": "<trunk protocol>", "hostname": <null or string>, "status": "OK\|Unknown\|None", "calls": <number>, "org_id": <organisation ID>, "system_id": <number>, "trunk_id": "<trunk identifier>", "ip_address": "<IP Address>, "system_name": "<string>", "data_source": "<string>" }, { ... } ]
	An array list of meeting objects for meetings between windowStart and windowEnd [ { "day": "YYYY-MM-DD", "name": "Meeting name", "participants": "Participants", "time": "YYYY-MM-DDTHH:mm:SS.sssZ", "type": "<meeting type>", "host": "<meeting host>", "presenting": <boolean>, "quality": "GOOD\|FAIR\|BAD\|UNKNOWN", "duration": <number>, "org_id": <organisation ID>, "meeting_id": "<meeting ID>", "start_time": "YYYY-MM-DDTHH:mm:SSZ", "end_time": "YYYY-MM-DDTHH:mm:SSZ", "participant_count": <number>, "system_id": <system ID>, "system_name": <string"> }, { ... } ]
Get Meetings	An array list of meeting objects for meetings between windowStart and windowEnd [ { "day": "YYYY-MM-DD", "name": "Meeting name", "participants": "Participants", "time": "YYYY-MM-DDTHH:mm:SS.sssZ", "type": "<meeting type>", "host": "<meeting host>", "presenting": <boolean>, "quality": "GOOD\|FAIR\|BAD\|UNKNOWN", "duration": <number>, "org_id": <organisation ID>, "meeting_id": "<meeting ID>", "start_time": "YYYY-MM-DDTHH:mm:SSZ", "end_time": "YYYY-MM-DDTHH:mm:SSZ", "participant_count": <number>, "system_id": <system ID>, "system_name": <string"> }, { ... } ]
Get Meeting Participants	An array of participant objects [ { "day": "YYYY-MM-DD", "time": "YYYY-MM-DDTHH:mm:SS.sssZ", "bitrate": <number>, "presentation": "<string>", "jitter": <number>, "quality": "GOOD\|FAIR\|BAD\|UNKNOWN", "duration": <number>, "org_id": <organisation ID>, "meeting_id": "<string>", "meeting_start_time": "YYYY-MM-DDTHH:mm:SSZ", "meeting_name": "<string>", "participant_id": "<string>", "participant_name": "<string>", "participant_alias": "<string>", "start_time": "YYYY-MM-DDTHH:mm:SSZ", "end_time": "YYYY-MM-DDTHH:mm:SS.sssZ", "call_type": "Video\|Audio", "packet_loss_rate": <float>, "quality_details_updated": "YYYY-MM-DDTHH:mm:SS.sssZ" }, { ... } ]

Contact Us

For any assistance, Create a support case or email us at support@wxp.hp.com.

Tech_Insights Monitoring API - Query Responses

Contact Us