Retrieves all File Activities Detected within the Network.

Open in ChatGPT Open in ChatGPT to ask questions about this page
Open in Claude Open in Claude to ask questions about this page
Copy as MarkdownCopy this page as markdown to use with AI assistants
View as Markdown Open this page as markdown in a new tab

This API fetches a detailed list of file-related operations (create, open, modify, delete, etc.) occurring across all network devices. It also provides filters to narrow results by event type, device, file extension, domain, computer/group, and time range.

Request URL

https://{serverurl}/api/1.4/reports/dcm/filetrace Copied!

Scope

DesktopCentralCloud.DeviceControl.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Query Parameters

pageintegerOptional

Current page number for pagination

pagelimitintegerOptional

Number of records per page

periodintegerOptional

Filter based on time period
0 - This week
1 - This month
2 - This year
3 - Last week
4 - Last month
5 - Last 2 months
6 - Last 3 months
7 - Last 6 months
8 - Last 9 months
9 - Last year

eventintegerOptional

Filter based on file event type
0 - Unknown
1 - Create
2 - Open
3 - Delete
4 - Rename
5 - Modify
6 - Read
7 - Move
8 - Copy

isblockedintegerOptional

0 - Allowed
1 - Blocked

gidlongOptional

Filter devices connected to a particular group of computers. Group IDs can be obtained from /api/1.4/customgroup/getCGList

dipIdstringOptional

Filter file activities of a particular device using its device instance path

fileExtnstringOptional

Filter file activities by file extension

fileExtnGrpstringOptional

Filter file activities by file extension group

domainstringOptional

Filter the records based on domain names

numberOfDayslongOptional

Filter file activities that occurred in the last N days

startlongOptional

Start timestamp for date range filter

endlongOptional

End timestamp for date range filter

computerlongOptional

Filter devices connected to a particular computer. Resource IDs can be obtained from /api/1.0/som/computers

userlongOptional

Filter by user resource ID

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomains/api/1.4/reports/dcm/filetrace \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

Response Body - application/json
string

Sample Response: HTTP 200

File trace report response

Copied!
  {
    "response_code": 200,
    "message_type": "dcm",
    "message_response": {
      "total": 1,
      "limit": 25,
      "page": 1,
      "dcm": [
        {
          "created_time": 315513000000,
          "is_directory": 1,
          "extension": "folder",
          "file_name": "E:\\",
          "managedcomputer.friendly_name": "John",
          "domain_netbios_name": "WORKGROUP",
          "userresource.name": "John",
          "file_size": 0,
          "event_notified_time": 1755869433000,
          "device_name": "USB  SanDisk 3.2Gen1 USB Device",
          "event_type": 5,
          "modified_time": 315513000000,
          "operation_blocked": 0,
          "new_file_name": "",
          "process_name": "C:\\Windows\\explorer.exe",
          "accessed_time": 315513000000,
          "resource_name": "John"
        }
      ]
    },
    "message_version": "1.4",
    "status": "success"
  }
                
▼ Show full