Operations to query visitor user session data
GET: Query User Sessions
Description
Query user session data based on the filter criteria. The results are sorted by last login time in descending order. The search can be performed on MAC addresses, last session time, status, and any or all fields. The query is paged using index and count parameters with maximum size in 1000. The returned JSON object includes the number of records returned and next index to query if more. You can also download the queried result in CSV file with URL /api/connect/v1/clients/export. The export query does not have maximum size limit.
HTTP Method
GET
Resource URI
/api/connect/v1/clients
Requires OAuth
N
Parameters
Name |
Required |
Default |
Type |
Location |
Description |
---|---|---|---|---|---|
start |
N |
— |
String |
query |
Session start time based on last login time in UTC format. |
end |
N |
— |
String |
query |
Session end time based on last login time in UTC format. |
index |
N |
— |
String |
query |
Starting index of the query based on 0. |
count |
N |
— |
String |
query |
Number of records to query with the limit of 1000 at maximum. |
status |
N |
— |
String |
query |
Status of the users. Allowed: all,active. |
authtype |
N |
— |
String |
query |
Authentication type used by the user. Allowed values/formats:registration, SMS, social. |
mac |
N |
— |
String |
query |
MAC address in 00:11:22:33:44:55:66 format. If MAC address is used, all other parameters will be ignored. |
device |
N |
— |
String |
query |
Type of user's device. |
os |
N |
— |
String |
query |
Operating system of user's device. |
language |
N |
— |
String |
query |
Language served to the user. It can search by full language name or two-letter language code. |
all |
N |
— |
String |
query |
The search applies to all fields. |
Content Type
application/json
Sample Output (JSON)
{
"nextIndex": 2,
"timeZoneOffset": -28800000,
"queryRecordCount": 1000,
"timeZone": "Pacific Standard Time",
"records": [
{
"operatingSystem": "Intel Mac OS X 10",
"bytesSent": 599913,
"portal": "Mississauga",
"state": "inactive",
"lastAcceptTime": "Nov 30, 2017 6:39:35 PM",
"macAddress": "a4:5e:60:f0:ae:85",
"type": "CustomPortal",
"agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_6) AppleWebKit/603.3.8 (KHTML, like Gecko)",
"bandwidth": 0,
"Name": "Tamer",
"firstLoginTime": "Nov 30, 2017 6:39:17 PM",
"policyName": "HighSpeed",
"Email": "taibrahi@cisco.com",
"device": "Macintosh",
"bytesReceived": 1896932,
"location/Site": "Nortech Campus->Nortech-1->1st Floor->CMX Bar",
"lastLogoutTime": "Nov 30, 2017 7:09:35 PM",
"language": "English",
"authType": "REGISTRATION",
"lastLoginTime": "Nov 30, 2017 6:39:35 PM"
},
{
"operatingSystem": "Android 7",
"bytesSent": 389973,
"portal": "Mississauga",
"state": "inactive",
"lastAcceptTime": "Nov 7, 2017 5:58:26 PM",
"macAddress": "94:65:2d:8b:83:08",
"type": "CustomPortal",
"agent": "Mozilla/5.0 (Linux; Android 7.1.1; ONEPLUS A5000 Build/NMF26X; wv) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 Chrome/62.0.3202.84 Mobile Safari/537.36",
"bandwidth": 0,
"Name": "Shailesh",
"firstLoginTime": "Nov 7, 2017 5:57:57 PM",
"policyName": "HighSpeed",
"Email": "shaisoni@cisco.com",
"device": "Unknown",
"bytesReceived": 1628488,
"location/Site": "Nortech Campus->Nortech-1->1st Floor->Tm",
"lastLogoutTime": "Nov 7, 2017 6:22:55 PM",
"language": "English",
"authType": "REGISTRATION",
"lastLoginTime": "Nov 7, 2017 5:58:26 PM"
}
],
"returnRecordCount": 2
}