Zoho Lens - API Reports

Reports

Reports give you an account of all the remote assistance sessions conducted from your Zoho Lens account.

Required OAuth scope
This API can be accessed with the OAuth scope: ZohoLens.reportapi.READ

request_params	object
type	string Session type. Allowed values:[LS].
fromdate	long Unix Timestamp
todate	long Unix Timestamp
email	string To fetch reports conducted by specific technician.
index	long Page count
count	long Number of rows per page.

response_params	object
total_count	long Total count of session reports.
viewer_os	string OS type of the viewer.
viewer_ipaddress	string IP address of viewer.
viewer_email	string Email id of viewer.
agent_os	string OS type of agent.
agent_ipaddress	string IP address of agent.
agent_email	string Email id of the agent.
start_time	long Start time of session.
end_time	long End time in long (Unix Timestamp).
duration	string Duration of session.
display_name	string Display name
session_id	long Session key
session_type	string Session type
session_owner_email	string Owner of session

Get Session Reports

This API fetches you the reports of previously conducted sessions

Request Response

Copied
$ curl https://lens.zoho.com/api/v2/reports
-X GET
-H "Content-Type: application/x-www-form-urlencoded;charset=UTF-8"
-H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5"
-d "index=1&count=20&type=all&fromdate=1518546600000&todate=1519151400000&email=john@zohcorp.com"

Copied
HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8

   "response_params": {
        {
           "agent_email": "mark.k@gmail.com",
           "agent_ipaddress": "10.59.1.72",
           "session_owner_email": "frida.m@zylker.com",
           "end_time": 1481369155546,
           "session_id": 706174884,
           "display_name": "Mark",
           "agent_os": "Windows",
           "duration": 155493,
           "start_time": 1481369000053,
           "session_title": "On Demand Lens session #706174884",
           "session_type": "Lens Support",
           "viewer_email": "david.w@zylker.com",
           "viewer_ipaddress": "10.59.1.72"
   },

    {
           "agent_email": "hayley.c@gmail.com",
           "agent_ipaddress": "10.59.1.72",
           "session_owner_email": "frida.m@zylker.com",
           "end_time": 1491369155546,
           "session_id": 937974381,
           "display_name": "John",
           "agent_os": "Mac",
           "duration": 155443,
           "start_time": 14513693400053,
           "session_title": "On Demand Lens session #937974381",
           "session_type": "Lens Support",
           "viewer_email": "john.f@zylker.com",
           "viewer_ipaddress": "10.59.1.52"
   }
}