Retrieve OS disk space insights

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

Returns the devices affected by OS disk space issues. To obtain the insightId,profileId,categoryId use the All Insights API.

Request URL

https://{serverurl}/intelligence/api/insights/DEXInsightLowOsDiskSpaceView Copied!

Scope

DesktopCentralCloud.dex.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/DexViewData.v1+jsonapplication/DexViewData.v1+jsonCopied!

- Query Parameters

profileIdstringMandatory

Profile ID

categoryIdstringMandatory

Category ID

insightIdstringMandatory

Insight ID

SEARCH_COLUMNstringOptional

Search Columns
The following columns are available for searching with their respective data types: Resource.NAME (String), Computer.OS_VERSION (String), InvComputer.MODEL(String) .

To search using a single column, provide one value in SEARCH_COLUMN and the corresponding value in SEARCH_VALUE.
Example:
SEARCH_COLUMN=Resource.NAME
SEARCH_VALUE=Device1

To search using multiple columns, provide comma-separated column names in SEARCH_COLUMN and the corresponding comma-separated values in SEARCH_VALUE in the same order.
Example:
SEARCH_COLUMN=Resource.NAME,OS_NAME
SEARCH_VALUE=Device1,Windows 11

Note: The number of values in SEARCH_VALUE must match the number of columns specified in SEARCH_COLUMN.

SEARCH_VALUEstringOptional

Search Values
Provide the search value(s) corresponding to the column(s) specified in the SEARCH_COLUMN parameter. Multiple values must be provided in the same order as the column names.

pagestringOptional

Page number

pageLimitstringOptional

Number of items per page

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url 'https://appdomains/intelligence/api/insights/DEXInsightLowOsDiskSpaceView?profileId=SOME_STRING_VALUE&categoryId=SOME_STRING_VALUE&insightId=SOME_STRING_VALUE' \
  --header 'Accept: application/DexViewData.v1+json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object
Hide Sub-Attributes
resource_idstring

Unique identifier of the device

resource_namestring

Name of the device

resource_name_transformstring

Display name of the device

branch_office_namestring

Name of the remote office

branch_office_name_transformstring

Formatted remote office name

domain_netbios_namestring

NetBIOS domain name of the device

domain_netbios_name_transformstring

Formatted domain name

manufacturer_namestring

Device manufacturer

manufacturer_name_transformstring

Formatted manufacturer name

modelstring

Device model

model_transformstring

Formatted device model

os_namestring

Operating system name

os_name_transformstring

Formatted operating system name

os_versionstring

Operating system version

os_version_transformstring

Formatted OS version

disk_typestring

Type of disk (SSD/HDD/NVMe)

disk_type_transformstring

Formatted disk type

disk_modelstring

Disk model information

disk_model_transformstring

Formatted disk model

os_drive_total_sizestring

Total OS drive size in bytes

os_drive_total_size_transformstring

Formatted total OS drive size

os_drive_free_spacestring

Available free space in OS drive

os_drive_free_space_transformstring

Formatted free space value

processor_architecturestring

Processor architecture type

statusstring

Current device status

resourcelivestatus_statusstring

Resource live status

status_update_timestring

Last status update timestamp

data_post_timestring

Data collection timestamp

data_post_time_transformstring

Formatted data collection time

last_sync_timestring

Last synchronization time

osflavor_idstring

Operating system flavor identifier

Sample Response: HTTP 200

Copied!
  {
    "resource_id": "string",
    "resource_name": "string",
    "resource_name_transform": "string",
    "branch_office_name": "string",
    "branch_office_name_transform": "string",
    "domain_netbios_name": "string",
    "domain_netbios_name_transform": "string",
    "manufacturer_name": "string",
    "manufacturer_name_transform": "string",
    "model": "string",
    "model_transform": "string",
    "os_name": "string",
    "os_name_transform": "string",
    "os_version": "string",
    "os_version_transform": "string",
    "disk_type": "string",
    "disk_type_transform": "string",
    "disk_model": "string",
    "disk_model_transform": "string",
    "os_drive_total_size": "string",
    "os_drive_total_size_transform": "string",
    "os_drive_free_space": "string",
    "os_drive_free_space_transform": "string",
    "processor_architecture": "string",
    "status": "string",
    "resourcelivestatus_status": "string",
    "status_update_time": "string",
    "data_post_time": "string",
    "data_post_time_transform": "string",
    "last_sync_time": "string",
    "osflavor_id": "string"
  }
                
▼ Show full

Duration: 1 minute | Threshold: 30 | Lock period: 5 minutes

Duration - Time window for the threshold.
Threshold - Number of API calls allowed within the specified duration.
Lock Period - Wait time before consecutive API requests.