API - Get session information for specific dates

Summary

This section explains how to retrieve user accounting report.

API URL

http://unibox_public_ip/csvapi/get_accounting_report

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

     

API Response

The API will return back the accounting sessions in CSV format. The file contains the following fields:

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 
Duration 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

Example

http://unibox_public_ip/csvapi/get_accounting_report?cc=12345678&sd=2015-11-01&ed=2015-11-15

Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.