Fetch summary and impact metrics for an alert profile

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 profile summary fields and occurrence statistics for affected devices.

Request URL

https://{serverurl}/intelligence/api/alerts/alertSummary/{profileId}

Scope

DesktopCentralCloud.DEX.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

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

- Path Parameters

profileIdstringMandatory

- Query Parameters

alertIdstringOptional

Grouped alert identifier used when the profile type is grouped

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomains/intelligence/api/alerts/alertSummary/{profileId} \
  --header 'Accept: application/alertSummaryJson.v1+json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

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

Alert profile name

alertPrioritystring

Priority level of the profile

alertMetricstring

Comma separated list of metric names

eventConditionstring

Rendered event condition text

alertConditionstring

Rendered alert type condition text

isTroubleshootEnabledboolean

Troubleshoot feature flag

impactedDeviceCountlong

Count of impacted unique devices

firstOccurrencestring

Formatted timestamp of first occurrence

lastOccurrencestring

Formatted timestamp of latest occurrence

- HTTP code 500

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

Internal server error code for alert summary operation

errorMessagestring

Internal server error message for alert summary operation

Possible Response Codes

200HTTP code
500HTTP code

Sample Response: HTTP 200

Summary for grouped alert profile

Copied!
  {
    "eventCondition": "CPU usage above 90 % for 10 minutes",
    "isTroubleshootEnabled": false,
    "alertProfileName": "High CPU Spike",
    "firstOccurrence": "Apr 01, 2026 09:15 AM",
    "lastOccurrence": "Apr 02, 2026 11:40 AM",
    "alertMetric": "CPU Usage",
    "alertPriority": "High",
    "alertCondition": "Minimum number of 5 endpoints impacted in a day",
    "impactedDeviceCount": 12
  }
                
Show full

Sample Response: HTTP 500

Unexpected failure while fetching summary

Copied!
  {
    "errorMessage": "Unable to fetch alert summary due to internal error",
    "errorCode": "INTERNAL_ERROR"
  }
                
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.