List low backup-time devices

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 low backup-time battery details. To obtain the insightId,profileId,categoryId use the All Insights API.

Request URL

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

Scope

DesktopCentralCloud.dex.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

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

- Query Parameters

insightIdstringMandatory

Insight ID

profileIdstringMandatory

Profile ID

categoryIdstringMandatory

Category ID

SEARCH_COLUMNstringOptional

Search Columns
The following columns are available for searching with their respective data types: Resource.NAME (String), BATTERY_NAME (String), EXE_NAME (String), BATTERY_HEALTH_PERCENTAGE (Integer), CYCLE_COUNT (Integer), DESIGN_CAPACITY (Integer), FULL_CHARGE_CAPACITY (Integer), MANUFACTURER (String), SERIAL_NUMBER (String), CHEMISTRY (String), POWER_PLAN (String), Resource.DOMAIN_NETBIOS_NAME (String), BranchOfficeDetails.BRANCH_OFFICE_NAME (String), Computer.OS_NAME (String), Computer.OS_VERSION (String), InvComputer.MODEL (String), InvManufacturer.MANUFACTURER_NAME (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/DEXInsightBatteryLowBackupTimeView?insightId=SOME_STRING_VALUE&profileId=SOME_STRING_VALUE&categoryId=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

Remote office name

branch_office_name_transformstring

Formatted remote office name

domain_netbios_namestring

NetBIOS domain name

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

serial_numberstring

Device serial number

serial_number_transformstring

Formatted serial number

os_namestring

Operating system name

os_name_transformstring

Formatted operating system name

os_versionstring

Operating system version

os_version_transformstring

Formatted OS version

osflavor_idstring

OS flavor identifier

battery_namestring

Battery model name

battery_name_transformstring

Formatted battery name

battery_manufacturerstring

Battery manufacturer

battery_manufacturer_transformstring

Formatted battery manufacturer

chemistrystring

Battery chemistry type

chemistry_transformstring

Formatted battery chemistry

design_capacitystring

Original battery design capacity

design_capacity_transformstring

Formatted design capacity

full_charge_capacitystring

Current maximum charge capacity

full_charge_capacity_transformstring

Formatted full charge capacity

battery_healthstring

Battery health percentage

battery_health_transformstring

Formatted battery health

battery_charge_percentagestring

Current battery charge percentage

battery_charge_percentage_transformstring

Formatted battery charge percentage

cycle_countstring

Number of battery charge cycles

cycle_count_transformstring

Formatted cycle count

chargingstring

Charging time in seconds

charging_transformstring

Formatted charging time

dischargingstring

Battery discharge time in seconds

discharging_transformstring

Formatted discharge time

backup_timestring

Estimated backup time

backup_time_transformstring

Formatted backup duration

power_planstring

Current power plan

power_plan_transformstring

Formatted power plan

usage_percentagestring

Battery usage percentage

process_namestring

Process consuming battery

process_name_transformstring

Formatted process usage information

battery_warranty_expiry_datestring

Battery warranty expiry date

battery_warranty_expiry_date_transformstring

Formatted battery warranty expiry date

battery_warranty_statusstring

Battery warranty status

battery_warranty_status_transformstring

Formatted warranty status

device_warranty_expiry_datestring

Device warranty expiry date

device_warranty_expiry_date_transformstring

Formatted device warranty expiry date

statusstring

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

processor_architecturestring

Processor architecture

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",
    "serial_number": "string",
    "serial_number_transform": "string",
    "os_name": "string",
    "os_name_transform": "string",
    "os_version": "string",
    "os_version_transform": "string",
    "osflavor_id": "string",
    "battery_name": "string",
    "battery_name_transform": "string",
    "battery_manufacturer": "string",
    "battery_manufacturer_transform": "string",
    "chemistry": "string",
    "chemistry_transform": "string",
    "design_capacity": "string",
    "design_capacity_transform": "string",
    "full_charge_capacity": "string",
    "full_charge_capacity_transform": "string",
    "battery_health": "string",
    "battery_health_transform": "string",
    "battery_charge_percentage": "string",
    "battery_charge_percentage_transform": "string",
    "cycle_count": "string",
    "cycle_count_transform": "string",
    "charging": "string",
    "charging_transform": "string",
    "discharging": "string",
    "discharging_transform": "string",
    "backup_time": "string",
    "backup_time_transform": "string",
    "power_plan": "string",
    "power_plan_transform": "string",
    "usage_percentage": "string",
    "process_name": "string",
    "process_name_transform": "string",
    "battery_warranty_expiry_date": "string",
    "battery_warranty_expiry_date_transform": "string",
    "battery_warranty_status": "string",
    "battery_warranty_status_transform": "string",
    "device_warranty_expiry_date": "string",
    "device_warranty_expiry_date_transform": "string",
    "status": "string",
    "resourcelivestatus_status": "string",
    "status_update_time": "string",
    "data_post_time": "string",
    "data_post_time_transform": "string",
    "last_sync_time": "string",
    "processor_architecture": "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.