GET - Activity logs

Purpose

This API is used to get the activity logs of the user. (This is accessible for admin users only).

Request URL

http://calendar.zoho.com/api/v1/organization/activity

OAuth Scope

scope=ZohoCalendar.activity.ALL

(or)

scope=ZohoCalendar.activity.READ

ALL - Full access to activity

READ - Gets events through activity

Parameters

  • limitint, Mandatory

    Mentions the total number of records to be displayed in response per request.

  • startTimelong

    The start time denotes the time from which the logs need to be fetched. It must be mentioned in millis.

  • endTimelong

    The end time denotes the time until which the logs need to be fetched. It must be mentioned in millis.

  • lastEntityIdstring

    The last entity id is used to get the next set of responses if the total logs are more than the limit. It is provided in the response.

  • lastIndexTimestring

    The last index time is used to get the next set of responses if the total logs are more than the limit. It is provided in the response.

  • searchKeystring

    The search key should be used as Key:Value separated by ::

    Example-scgr:resources::ausername:user@zoho.com. Here Key- scgr, value -resources, Key- ausername, Value-user@zoho.com

    The possible scgr (sub-category) values are-

    • branches
    • resources
    • features
    • bookings
    • reports
    • calendarSettings
    • interoperabilitySettings
    • buildings
    • floors
    • zRBUserSettings
    • zcalcpanelsettings

    ex: scrg:branches

Note:

If the total number of records exceeds the limit given, use the last entity id and last index time provided in the response to fetch the next set of data.

 

Sample Request 1- limit

Copiedhttp://calendar.zoho.com/api/v1/organization/activity?limit=10

Sample Request 2-searchKey ( fetch resource subcategory logs done by user mentioned )

Copiedhttps://calendar.zoho.com/api/v1/organization/activity?limit=3&searchKey=scgr:resources::ausername:user@zoho.com

Sample Request 3- searchKey ( fetch branches subcategory logs )

Copiedhttps://calendar.zoho.com/api/v1/organization/activity?limit=3&searchKey=scgr:branches

Sample Response 1- limit

Copied{
    "data": {
        "lastIndexTime": "1695280570886003",
        "audit": [
            {
                "requestTime": 1695376234990,
                "subCategory": "ZRB_FEATURES",
                "performedBy": "user@zoho.com",
                "data": "{\"feature\":{\"feature_id\":\"1695376234969000001\",\"feature_type\":0,\"feature_name\":\"Chair\",\"is_hidden\":false}}",
                "clientIp": "172.24.203.120",
                "mainCategory": "CALENDAR",
                "operationType": "ADD",
                "performedOn": "Chair",
                "type": "USER",
                "operation": "RB_CREATE",
                "status": "success"
            },
            {
                "requestTime": 1695376142126,
                "subCategory": "ZRB_RESOURCES",
                "performedBy": "user@zoho.com",
                "data": "{\"resource_type\":0,\"location\":\"Floor 1, Tower, Test Branch\",\"message\":\"Resource added by user2\",\"category\":0,\"capacity\":1}",
                "clientIp": "172.24.203.120",
                "mainCategory": "CALENDAR",
                "operationType": "ADD",
                "performedOn": "Room 1",
                "type": "USER",
                "operation": "RESOURCE_CREATE",
                "status": "success"
            },
            {
                "requestTime": 1695376101435,
                "subCategory": "ZRB_BUILDINGS",
                "performedBy": "user@zoho.com",
                "data": "{\"building_name\":\"Tower\",\"message\":\"Building added by user2\",\"floor_count\":1}",
                "clientIp": "172.24.203.120",
                "mainCategory": "CALENDAR",
                "operationType": "ADD",
                "performedOn": "Tower",
                "type": "USER",
                "operation": "BUILDING_CREATE",
                "status": "success"
            },
            {
                "requestTime": 1695376031824,
                "subCategory": "ZRB_ORG_SETTINGS",
                "performedBy": "user@zoho.com",
                "data": "{\"settings\":{\"bk_abandon_period\":10,\"min_booking_dur\":30,\"resource_replacement\":false,\"grid_view\":0,\"type_settings\":[],\"bk_confirm\":false,\"has_resource\":true,\"max_dur\":4,\"checkIn\":false,\"bk_confirm_period\":30,\"rsvp_resource_release\":false,\"max_booking_dur\":2160,\"bk_abandon_protect\":false,\"rsvp_resource_release_period\":30}}",
                "clientIp": "172.20.3.127",
                "mainCategory": "CALENDAR",
                "operationType": "UPDATE",
                "performedOn": "87872743",
                "type": "USER",
                "operation": "RB_UPDATE",
                "previousData": "{\"prevSettings\":{\"bk_abandon_period\":10,\"min_booking_dur\":30,\"resource_replacement\":false,\"grid_view\":0,\"type_settings\":[],\"bk_confirm\":false,\"has_resource\":true,\"max_dur\":3,\"checkIn\":false,\"bk_confirm_period\":30,\"rsvp_resource_release\":false,\"max_booking_dur\":2160,\"bk_abandon_protect\":false,\"rsvp_resource_release_period\":30}}",
                "status": "success"
            },
            {
                "requestTime": 1695376026178,
                "subCategory": "ZRB_ORG_SETTINGS",
                "performedBy": "user@zoho.com",
                "data": "{\"settings\":{\"bk_abandon_period\":10,\"min_booking_dur\":30,\"resource_replacement\":false,\"grid_view\":0,\"type_settings\":[],\"bk_confirm\":false,\"has_resource\":true,\"max_dur\":3,\"checkIn\":false,\"bk_confirm_period\":30,\"rsvp_resource_release\":false,\"max_booking_dur\":2160,\"bk_abandon_protect\":false,\"rsvp_resource_release_period\":30}}",
                "clientIp": "172.20.3.127",
                "mainCategory": "CALENDAR",
                "operationType": "UPDATE",
                "performedOn": "87872743",
                "type": "USER",
                "operation": "RB_UPDATE",
                "previousData": "{\"prevSettings\":{\"bk_abandon_period\":10,\"min_booking_dur\":15,\"resource_replacement\":false,\"grid_view\":0,\"type_settings\":[],\"bk_confirm\":false,\"has_resource\":true,\"max_dur\":3,\"checkIn\":false,\"bk_confirm_period\":30,\"rsvp_resource_release\":false,\"max_booking_dur\":2160,\"bk_abandon_protect\":false,\"rsvp_resource_release_period\":30}}",
                "status": "success"
            },
            {
                "requestTime": 1695364533962,
                "subCategory": "ZRB_RESOURCES",
                "performedBy": "user@zoho.com",
                "data": "{\"resource_type\":4,\"resource_id\":\"1695363680538000001\",\"location\":\"Floor Number - 2, Woodlands, Test M92\",\"category\":3,\"message\":\"Resource updated by user2\",\"capacity\":0}",
                "clientIp": "172.24.203.120",
                "mainCategory": "CALENDAR",
                "operationType": "UPDATE",
                "performedOn": "Dorm 1",
                "type": "USER",
                "operation": "RESOURCE_UPDATE",
                "previousData": "{\"branch_id\":1695362830502000001,\"resource_type\":4,\"location\":\"Floor Number - 2, Woodlands, Test M92\",\"resource_name\":\"Dorm 1\",\"category\":3,\"capacity\":0}",
                "status": "success"
            },
            {
                "requestTime": 1695362957390,
                "subCategory": "ZRB_RESOURCES",
                "performedBy": "user@zoho.com",
                "data": "{\"resource_type\":0,\"location\":\"Floor Number - 2, Woodlands, Test M92\",\"message\":\"Resource added by user2\",\"category\":0,\"capacity\":1}",
                "clientIp": "172.24.203.120",
                "mainCategory": "CALENDAR",
                "operationType": "ADD",
                "performedOn": "Room 2",
                "type": "USER",
                "operation": "RESOURCE_CREATE",
                "status": "success"
            },
            {
                "requestTime": 1695362830759,
                "subCategory": "ZRB_RESOURCES",
                "performedBy": "user@zoho.com",
                "data": "{\"resource_type\":0,\"location\":\"Floor Number - 2, Woodlands, Test M92\",\"message\":\"Resource added by user2\",\"category\":0,\"capacity\":25}",
                "clientIp": "172.24.203.120",
                "mainCategory": "CALENDAR",
                "operationType": "ADD",
                "performedOn": "Room 1",
                "type": "USER",
                "operation": "RESOURCE_CREATE",
                "status": "success"
            },
            {
                "requestTime": 1695362830554,
                "subCategory": "ZRB_BUILDINGS",
                "performedBy": "user@zoho.com",
                "data": "{\"building_name\":\"Woodlands\",\"message\":\"Building added by user2\",\"floor_count\":3}",
                "clientIp": "172.24.203.120",
                "mainCategory": "CALENDAR",
                "operationType": "ADD",
                "performedOn": "Woodlands",
                "type": "USER",
                "operation": "BUILDING_CREATE",
                "status": "success"
            },
            {
                "requestTime": 1695280630095,
                "subCategory": "ZCAL_CPANEL_SETTINGS",
                "performedBy": "user@zoho.com",
                "data": "{\"OrgSettings\":{\"CAL_SHARE\":1,\"FREEBUSY_STATUS\":1,\"ADD_GRP_INV_USER_PREF\":1,\"ADD_GRP_INV\":0,\"CAL_HOLIDAY\":1,\"PRIVATE_URL\":1,\"IMPORT_EXPORT\":1,\"AUTO_ADD_INV\":-1,\"CAL_SUBSCRIBE\":2,\"MOD_NOTIFY_EMAIL\":2,\"ALIAS_EMAIL\":1,\"SEND_INVITATION\":1}}",
                "clientIp": "172.24.203.120",
                "mainCategory": "CALENDAR",
                "operationType": "UPDATE",
                "performedOn": "87872743",
                "type": "USER",
                "operation": "ORG_SETTINGS_UPDATE",
                "previousData": "{\"CAL_SHARE\":2,\"FREEBUSY_STATUS\":1,\"ADD_GRP_INV_USER_PREF\":1,\"ADD_GRP_INV\":0,\"CAL_HOLIDAY\":1,\"PRIVATE_URL\":1,\"IMPORT_EXPORT\":1,\"AUTO_ADD_INV\":-1,\"CAL_SUBSCRIBE\":2,\"MOD_NOTIFY_EMAIL\":2,\"ALIAS_EMAIL\":0,\"SEND_INVITATION\":1}",
                "status": "success"
            }
        ],
        "lastEntityId": "1695280570886003_sas@172.20.24.55"
    },
    "status": {
        "code": 200,
        "description": "success"
    }
}

Sample Response 2- searchKey (fetch resource subcategory logs done by user mentioned )

Copied {
    "data": {
        "lastIndexTime": "1692856599996000",
        "audit": [
            {
                "requestTime": 1692876101242,
                "subCategory": "ZRB_RESOURCES",
                "performedBy": "user@zoho.com",
                "data": "{\"resource_type\":0,\"resource_id\":\"1678701991533000001\",\"location\":\"Vv floor1, Vv building1, Vadivelu Branch\",\"category\":0,\"message\":\"Resource updated by Jashan\",\"capacity\":10}",
                "clientIp": "172.24.203.120",
                "mainCategory": "CALENDAR",
                "operationType": "UPDATE",
                "performedOn": "Vv room1",
                "type": "USER",
                "operation": "RESOURCE_UPDATE",
                "previousData": "{\"branch_id\":1678701950413000001,\"resource_type\":0,\"location\":\"Vv floor1, Vv building1, Vadivelu Branch\",\"resource_name\":\"Vv room1\",\"category\":0,\"capacity\":15}",
                "status": "success"
            },
            {
                "requestTime": 1692875385688,
                "subCategory": "ZRB_RESOURCES",
                "performedBy": "user@zoho.com",
                "data": "{\"resource_type\":0,\"resource_id\":\"1678701991533000001\",\"location\":\"Vv floor1, Vv building1, Vadivelu Branch\",\"category\":0,\"message\":\"Resource updated by Jashan\",\"capacity\":15}",
                "clientIp": "172.24.203.120",
                "mainCategory": "CALENDAR",
                "operationType": "UPDATE",
                "performedOn": "Vv room1",
                "type": "USER",
                "operation": "RESOURCE_UPDATE",
                "previousData": "{\"branch_id\":1678701950413000001,\"resource_type\":0,\"location\":\"Vv floor1, Vv building1, Vadivelu Branch\",\"resource_name\":\"Vv room1\",\"category\":0,\"capacity\":10}",
                "status": "success"
            },
            {
                "requestTime": 1692856599996,
                "subCategory": "ZRB_RESOURCES",
                "performedBy": "user@zoho.com",
                "data": "{\"resource_type\":0,\"location\":\"Floor 4, Tower 1, NewOneBranch\",\"message\":\"Resource added by Jashan\",\"category\":0,\"capacity\":10}",
                "clientIp": "172.20.30.22",
                "mainCategory": "CALENDAR",
                "operationType": "ADD",
                "performedOn": "Room 2",
                "type": "USER",
                "operation": "RESOURCE_CREATE",
                "status": "success"
            }
        ],
        "lastEntityId": "1692856599996000_sas@172.20.25.242"
    },
    "status": {
        "code": 200,
        "description": "success"
    }
}

Sample Response 3- Sample Response : ( fetch branches subcategory logs )

Copied{
    "data": {
        "lastIndexTime": "1686737556040000",
        "audit": [
            {
                "requestTime": 1687176833739,
                "subCategory": "ZRB_BRANCHES",
                "performedBy": "user@zoho.com",
                "data": "{\"is_any_day\":false,\"has_resource\":false,\"work_end_hour\":\"12:00 am\",\"branch_id\":\"1687176833693000001\",\"branch_name\":\"1. Create an event. Save Four Reminders and Skype Meeting.  2. Click on the meeting reminder. One reminder is displayed.  3. In a reminder meeting, after a refresh meeting is created,v\",\"work_start_day\":1,\"work_start_hour\":\"12:00 am\",\"time_zone\":\"Asia/Kolkata\",\"message\":\"Branch added by Jashan\",\"work_end_day\":5,\"has_resource_manager\":false}",
                "clientIp": "172.24.206.58",
                "mainCategory": "CALENDAR",
                "operationType": "ADD",
                "performedOn": "1. Create an event. Save Four Reminders and Skype Meeting.  2. Click on the meeting reminder. One reminder is displayed.  3. In a reminder meeting, after a refresh meeting is created,v",
                "type": "USER",
                "operation": "BRANCH_CREATE",
                "status": "success"
            },
            {
                "requestTime": 1687174754181,
                "subCategory": "ZRB_BRANCHES",
                "performedBy": "user@zoho.com",
                "data": "{\"is_any_day\":false,\"has_resource\":false,\"work_end_hour\":\"12:00 am\",\"branch_id\":\"1687174754172000001\",\"branch_name\":\"School\",\"work_start_day\":1,\"work_start_hour\":\"12:00 am\",\"notify_email\":\"user@zoho.com\",\"time_zone\":\"Asia/Kolkata\",\"message\":\"Branch added by Jashan\",\"work_end_day\":5,\"has_resource_manager\":false}",
                "clientIp": "172.24.206.58",
                "mainCategory": "CALENDAR",
                "operationType": "ADD",
                "performedOn": "School",
                "type": "USER",
                "operation": "BRANCH_CREATE",
                "status": "success"
            },
            {
                "requestTime": 1686737556040,
                "subCategory": "ZRB_BRANCHES",
                "performedBy": "user@zoho.com",
                "data": "{\"is_any_day\":false,\"has_resource\":false,\"work_end_hour\":\"12:00 am\",\"branch_id\":\"1686737555967000001\",\"branch_name\":\"Days\",\"work_start_day\":1,\"work_start_hour\":\"12:00 am\",\"notify_email\":\"user2@cal1.nashs.in\",\"time_zone\":\"Asia/Kolkata\",\"message\":\"Branch added by Jashan\",\"work_end_day\":5,\"has_resource_manager\":false}",
                "clientIp": "172.24.206.58",
                "mainCategory": "CALENDAR",
                "operationType": "ADD",
                "performedOn": "Days",
                "type": "USER",
                "operation": "BRANCH_CREATE",
                "status": "success"
            }
        ],
        "lastEntityId": "1686737556040000_sas@172.20.24.55"
    },
    "status": {
        "code": 200,
        "description": "success"
    }
}