API - Get login session information


This section explains how to retrieve login sessions for users within specific dates.



API Request

Following parameters need to be passed to the API

Parameter Name Constraint Description
cc required Unique customer code/password. You will find the customer code under Admin -> Profile section
sd required

Start Date for the query. YYYY-MM-DD format

e.g. 2015-11-01

ed required

End Date for the query. YYYY-MM-DD format

e.g. 2015-11-02

hid optional

Hotspot ID. If this parameter is passed, the sessions will be filtered using the ID. Location ID can be found under Authentication -> Hotspot -> List Hotspots section.

API Response

The response is passed based in JSON format. You will need to parse the JSON format and convert in the format desired.

Parameter Name Description
UserName  Username who has logged in
Location name Hotspot venue from where the user has logged in
Client MAC Address The MAC address of the client machine
Client IP Address The IP address of the client machine
AP MAC Address The MAC address of the AP or gateway
Session Start Time The session start time in YYYY-MM-DD HH:MM::SS format
Session Stop Time The session stop time in YYYY-MM-DD HH:MM::SS format 
Session Time Total login duration in seconds
Upload (bytes) Total uploaded bytes during the session
Download (bytes) Total downloaded bytes during the session
Terminate Cause The reason why the user session was terminated/closed




Have more questions? Submit a request


Please sign in to leave a comment.