This API fetches you the reports of previously conducted sessions.

GET /api/v2/reports


OAuth Scope

ZohoAssist.reportapi.READ


Query Parameters

  • Parameters
    Description
  • type
    Required
    Session type.Allowed Values: [rs|URS|all]
  • fromdate
    Required
    long (Unix Timestamp).
  • todate
    Required
    long (Unix Timestamp).
  • email
    Optional
    To fetch reports conducted by specific technician.
  • index
    Optional
    Index of the record.
  • count
    Optional
    Number of rows per page

Get Session Reports

RequestResponse
Copiedcurl --location 'https://assist.zoho.com/api/v2/reports?index=1&count=20&type=all&fromdate=1518546600000&todate=1519151400000&email=john%40zohcorp.com' \
--header 'Content-Type: application/x-www-form-urlencoded;charset=UTF-8' \
--header 'Authorization: Zoho-oauthtoken 1000.84f8*****************************************'
CopiedHTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{

    "total_count": 29,
    "resource_type": "report",
    "representation": [
        {
            "viewer_os": "Mac",
            "viewer_ipaddress": "121.244.91.19",
            "viewer_email": "david.w@zylker.com",
            "agent_os": "Mac",
            "agent_ipaddress": "45.123.3.250",
            "agent_email": "mark.k@gmail.com",
            "start_time": 1481369000053,
            "end_time": 1481369155546,
            "duration": "155493",
            "display_name": "Mark",
            "session_id": 706174884,
            "session_type": "Remote Support",
            "session_owner_email": "frida.m@zylker.com",
            "date": 1481369000053,
            "time": 1481369000053
        },
        {
            "viewer_os": "Windows",
            "viewer_ipaddress": "122.144.72.18",
            "viewer_email": "john.f@zylker.com",
            "agent_os": "Windows",
            "agent_ipaddress": "95.345.1.50",
            "agent_email": "hayley.c@gmail.com",
            "start_time": 1581299000053,
            "end_time": 1681378199946,
            "duration": "1553",
            "display_name": "Hayley",
            "session_id": 937974381,
            "session_type": "Screen Sharing",
            "session_owner_email": "john.f@zylker.com",
            "date": 1581299000053,
            "time": 1581299000053
        }
    ],
    "page": {
        "next": "https://assist.zoho.com/api/v2/reports?todate=1495132200000&count=20&index=21&type=all&fromdate=1463596200000",
        "first": "https://assist.zoho.com/api/v2/reports?todate=1495132200000&count=20&index=1&type=all&fromdate=1463596200000",
        "last": "https://assist.zoho.com/api/v2/reports?todate=1495132200000&count=20&index=10&type=all&fromdate=1463596200000"
    }
}