Retrieves detailed summary for SoM Computers

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

Retrieves the SoM computer summary based on agent installation status and the last agent contact time.

Endpoints

Request URL

https://{serverurl}/api/1.4/som/summary

Scope

DesktopCentralCloud.Common.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Query Parameters

pagestringOptional

Specifies the page number to retrieve. Default is 1

pagelimitstringOptional

Specifies the maximum number of items to return per page. The default value is 25. A maximum of 1000 records can be retrieved in a single request

Sample Request

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

Response Parameters

- HTTP code 200

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

Name of the module

message_responseJSON Object

Response message containing summary details

Show Sub-Attributes
summaryJSON Object
Show Sub-Attributes
last_contact_time_summaryJSON Object

Computer summary based on the computer's most recent contact with the server

Show Sub-Attributes
equal_3_dayinteger

No of agents contacted server in last 3 days

4_day_to_7_dayinteger

No of agents contacted server between 4 and 7 days ago

8_day_to_15_dayinteger

No of agents contacted server between 8 and 15 days ago

16_day_to_30_dayinteger

No of agents contacted server between 16 and 30 days ago

greater_30_dayinteger

Agent has not contacted the server in the last 30 days

installation_status_summaryJSON Object

Computer summary based on the agent installation state of each device

Show Sub-Attributes
uninstallation_failedinteger

No of computers where agent uninstallation failed

installedinteger

No of computers where agent was installed successfully

totalinteger

No of Computers in Endpoint central

installation_failedinteger

No of computers where agent intallation failed

yet_to_installinteger

No of computers where the agent yet to be installed

uninstalledinteger

No of computers where the agent was unistalled successfully

live_status_summaryJSON Object

Computer summary categorized by the live status of each device

Show Sub-Attributes
downinteger

No of computers in down state

liveinteger

No of computers in live state

unknowninteger

No of computers with unknown state

message_versionstring

Version of the Api

statusstring

Status of the request

Possible Response Codes

200HTTP code

Request processed successfully

Sample Response: HTTP 200

Copied!
  {
    "message_type": "summary",
    "message_response": {
      "summary": {
        "last_contact_time_summary": {
          "equal_3_day": 2,
          "8_day_to_15_day": 0,
          "16_day_to_30_day": 0,
          "greater_30_day": 0,
          "4_day_to_7_day": 1
        },
        "installation_status_summary": {
          "uninstallation_failed": 1,
          "installed": 1,
          "total": 3,
          "installation_failed": 0,
          "yet_to_install": 1,
          "uninstalled": 0
        },
        "live_status_summary": {
          "down": 0,
          "live": 3,
          "unknown": 0
        }
      }
    },
    "message_version": "1.4",
    "status": "success"
  }
                
Show full

Duration: 1 minute | Threshold: 120 | 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.