Historic Client Connections

Fetch the client connection level-historical details for the specified timestamp.

API Calls
Get

/v5/devices/clientconnections/{stime}

Get Historic Client Connections

Description Fetches the client connection level-historical details for the specified timestamp.
Who Can Execute? Superuser, Administrator, Operator, and Viewer.
Syntax
GET <Base_URL>/devices/clientconnections/{stime}?totalcountrequired=<value>&
locationid=<value>&nodeid=<value>&filter=<value>&pagesize=<value>
&sortascending=<value>&sortcolumn=<value>
    • stime

      Time in epoch format to access Client connections snapshot. It takes integer value.

    • totalcountrequired

      A true or false value indicating whether to display the total count of client connections snapshot records.
      It takes boolean value.

    • locationid

      It is an integer value specifying the location for which the list of groups is to be fetched.
      To retrieve the value for location id refer Location call.

    • nodeid

      It is an integer value specifying the node in a server cluster setup.

    • filter

      Is used to filter the results. Click Filter to view details of how filters need to be specified in the URL.
      For possible names of property attribute, datatypes, applicable values and whether the results can be
      sorted based on the parameter click Historic Client Connections Filter.

    • pagesize

      An integer value indicating the end index for the list of clients to be fetched. The maximum page size is
      1000.

    • sortascending

      Is used to sort requested managed devices list in a ascending order. By default, the sort is descending.
      It takes a boolean value.

    • sortcolumn

      An optional parameter used to sort the columns. It takes a string value.
Sample code
GET https://training.mojonetworks.com/new/webservice/v5/devices/clientconnections
/1554930900000?CID=ATN9&totalcountrequired=true&locationid=0&nodeid=0&
filter=%7B%22property%22%3A%22performanceFlag%22%2C%22value%22%3A%5B1%5D%2C%22operator%22%3A%22bitwise_
and%22%7D&pagesize=100&sortascending=true&sortcolumn=rssi&startindex=0
Request Body This API call does not require any request body parameters.
Response Body If the API call is successful, the HTTP response status is 200. The response body contains the client
connection level-historical details for the specified timestamp.
The response is in the application/json format.
JSON Table

Attribute Data Type Description
count
results
results/clientSnapshot
results/clientSnapshot/macaddress
results/clientSnapshot/timestamp
results/clientSnapshot/os
results/clientSnapshot/role
results/clientSnapshot/upDownSince
results/clientSnapshot/firstDetectedAt
results/clientSnapshot/googleAuthorizationStatus
results/clientSnapshot/vendor
results/clientSnapshot/smartDeviceType
results/clientSnapshot/name
results/clientSnapshot/username
results/clientSnapshot/capability
results/protocol
results/rssi
results/averageDataRate
results/channel
results/associatedApMac
results/ssid
results/upLinkData
results/downLinkData
results/locationId
results/failureCodes
results/lastFailureTime
results/dhcpLatency
results/dnsLatency
results/aaaLatency
results/wanLatency
results/wanWiredLatency
results/wanWirelessLatency
results/ownSensorBoxId
results/connectivityFlag
results/performanceFlag
results/associatedApName
results/upLinkDataRate
results/downLinkDataRate
results/retryRate
results/failureCount
results/successCount
results/poorPerformanceReasons
results/locationName
results/ip
results/ipV6
results/sticky
results/dhcpServerIp
results/dnsServerIp
results/aaaServerIp
pagingSessionId

Sample JSON 
{
	"count": 2,
	"results": [{
		"clientSnapshot": {
			"macaddress": "74:8D:08:27:BC:2C",
			"timestamp": 1554930900000,
			"os": "Apple iOS v9.0+",
			"role": "--",
			"upDownSince": 1554918820000,
			"firstDetectedAt": 1488535180000,
			"googleAuthorizationStatus": "NOT_AVAILABLE",
			"vendor": "Apple",
			"smartDeviceType": "SMART_DEVICE",
			"name": "iPhone",
			"username": "saurabhm",
			"capability": 3
		},
		"protocol": "A",
		"rssi": -71,
		"averageDataRate": 385832,
		"channel": 149,
		"associatedApMac": "88:B1:E1:20:94:4F",
		"ssid": "MOJO-BYOD",
		"upLinkData": 9,
		"downLinkData": 14,
		"locationId": {
			"type": "locallocationid",
			"id": 26
		},
		"failureCodes": null,
		"lastFailureTime": null,
		"dhcpLatency": null,
		"dnsLatency": null,
		"aaaLatency": null,
		"wanLatency": 8,
		"wanWiredLatency": 1,
		"wanWirelessLatency": 7,
		"ownSensorBoxId": 1092,
		"connectivityFlag": null,
		"performanceFlag": 7,
		"associatedApName": "C130_Omega_20:94:4F",
		"upLinkDataRate": 256293,
		"downLinkDataRate": 444444,
		"retryRate": 0.0,
		"failureCount": null,
		"successCount": null,
		"poorPerformanceReasons": ["LOW_RSSI"],
		"locationName": "Phi",
		"ip": "10.86.18.87",
		"ipV6": null,
		"sticky": false,
		"dhcpServerIp": null,
		"dnsServerIp": null,
		"aaaServerIp": null
	}, {
		"clientSnapshot": {
			"macaddress": "B0:C0:90:2C:84:B6",
			"timestamp": 1554930900000,
			"os": null,
			"role": "--",
			"upDownSince": 1554122068000,
			"firstDetectedAt": 1518525169000,
			"googleAuthorizationStatus": "NOT_AVAILABLE",
			"vendor": "Chicony-Electronics",
			"smartDeviceType": "NOT_A_SMART_DEVICE",
			"name": "automation-test",
			"username": "devangv",
			"capability": 3
		},
		"protocol": "A",
		"rssi": -69,
		"averageDataRate": 6001,
		"channel": 44,
		"associatedApMac": "00:11:74:D0:76:BF",
		"ssid": "Spectrum-a",
		"upLinkData": 1,
		"downLinkData": 2,
		"locationId": {
			"type": "locallocationid",
			"id": 4
		},
		"failureCodes": null,
		"lastFailureTime": null,
		"dhcpLatency": null,
		"dnsLatency": null,
		"aaaLatency": null,
		"wanLatency": 0,
		"wanWiredLatency": 0,
		"wanWirelessLatency": 0,
		"ownSensorBoxId": 1075,
		"connectivityFlag": null,
		"performanceFlag": 5,
		"associatedApName": "C75_Gamma_D0:76:BF",
		"upLinkDataRate": 6001,
		"downLinkDataRate": 0,
		"retryRate": 0.0,
		"failureCount": null,
		"successCount": null,
		"poorPerformanceReasons": ["LOW_DATA_RATE"],
		"locationName": "Gamma",
		"ip": "10.86.11.200",
		"ipV6": null,
		"sticky": false,
		"dhcpServerIp": null,
		"dnsServerIp": null,
		"aaaServerIp": null
	}],
	"pagingSessionId": null
}