Retrieves the full node tree for a score 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 the full score node hierarchy for a score profile, including node metadata, enablement, descriptions, weightage contribution, and leaf score configuration.

Request URL

https://{serverurl}/intelligence/api/scoreSettings/profiles/{scoreProfileId}/nodes

Scope

DesktopCentralCloud.DEX.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

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

- Path Parameters

scoreProfileIdstringMandatory

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomains/intelligence/api/scoreSettings/profiles/{scoreProfileId}/nodes \
  --header 'Accept: application/scoreNodes.v1+json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

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

Unique identifier of the root score node

displayNamestring

Localized display name of the node

scoreKeystring

Internal score key of the node

weightagestring

Configured weightage of the node among its siblings

percentContribstring

Rounded percent contribution of the node to its parent

scoreNodeLevelstring

Numeric level of the node in the score tree

isDefaultboolean

Whether the node comes from the default profile definition

engageModeboolean

Whether the node belongs to engage mode

nodeChildsJSON Array

Child category nodes under the root node

Show Sub-Attributes
JSON Object
Show Sub-Attributes
scoreNodeIdlong

Unique identifier of the category node

displayNamestring

Localized display name of the category

scoreKeystring

Internal score key of the category

weightagestring

Configured weightage of the category among its siblings

percentContribstring

Rounded percent contribution of the category to its parent

scoreNodeLevelstring

Numeric level of the category node in the score tree

isDefaultboolean

Whether the category is part of the default profile definition

engageModeboolean

Whether the category belongs to engage mode

isEnabledboolean

Whether the category is enabled for score calculation

descriptionstring

Localized description of the category

nodeChildsJSON Array

Leaf metric nodes that belong to this category

Show Sub-Attributes
JSON Object
Show Sub-Attributes
scoreNodeIdlong

Unique identifier of the metric node

displayNamestring

Localized display name of the metric

scoreKeystring

Internal score key of the metric

weightagestring

Configured weightage of the metric among its siblings

percentContribstring

Rounded percent contribution of the metric to its parent

scoreNodeLevelstring

Numeric level of the metric node in the score tree

isDefaultboolean

Whether the metric is part of the default profile definition

engageModeboolean

Whether the metric belongs to engage mode

isEnabledboolean

Whether the metric is enabled for score calculation

descriptionstring

Localized description of the metric

unitstring

Display unit of the metric value

scoreConfigJSON Object

Scoring-function configuration of the metric

Show Sub-Attributes
scoreFunctionstring

Internal score function identifier used by the metric

uiLimitsJSON Object

Minimum and maximum raw values shown in the UI

Show Sub-Attributes
minValuestring

Minimum raw value shown in the configuration UI

maxValuestring

Maximum raw value shown in the configuration UI

scoreParamsJSON Array

Score function parameter rows used to calculate the metric score

Show Sub-Attributes
JSON Object
Show Sub-Attributes
minValuestring

Lower raw value boundary for this scoring row

maxValuestring

Upper raw value boundary for this scoring row

healthstring

Health bucket associated with this scoring row

scorestring

Score returned by step or lookup scoring functions; null for piecewise linear configurations

minScorestring

Minimum score for piecewise linear configurations; null for non-piecewise configurations

maxScorestring

Maximum score for piecewise linear configurations; null for non-piecewise configurations

valuestring

Exact raw value for value-based configurations; null when not applicable

uiConfigJSON Object

Additional UI configuration, present for piecewise linear functions and null otherwise

Show Sub-Attributes
stepstring

Step value used by piecewise linear metric configuration

nodeChildsarray

Leaf nodes do not have child nodes

totalChildrenWeightagestring

Sum of enabled child metric weightages under this category

totalChildrenWeightagestring

Sum of enabled child node weightages under the root

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Copied!
  {
    "scoreNodeId": 1,
    "weightage": 5,
    "scoreKey": "ROOT",
    "isDefault": true,
    "percentContrib": 100,
    "displayName": "Experience Score",
    "scoreNodeLevel": 0,
    "engageMode": false,
    "totalChildrenWeightage": 3,
    "nodeChilds": [
      {
        "scoreNodeId": 101,
        "weightage": 3,
        "scoreKey": "DEVICE_PERFORMANCE",
        "isDefault": true,
        "percentContrib": 60,
        "displayName": "Device Performance",
        "isEnabled": true,
        "scoreNodeLevel": 1,
        "engageMode": false,
        "description": "Tracks performance related metrics",
        "totalChildrenWeightage": 2,
        "nodeChilds": [
          {
            "scoreNodeId": 301,
            "weightage": 2,
            "scoreKey": "CPU_USAGE",
            "displayName": "CPU Usage",
            "engageMode": false,
            "description": "Average CPU usage",
            "isDefault": true,
            "unit": "%",
            "percentContrib": 66.7,
            "isEnabled": true,
            "scoreNodeLevel": 2,
            "scoreConfig": {
              "scoreParams": [
                {
                  "score": 100,
                  "minValue": "0",
                  "minScore": null,
                  "maxValue": "20",
                  "health": 2,
                  "maxScore": null,
                  "value": null
                }
              ],
              "uiConfig": null,
              "scoreFunction": 1,
              "uiLimits": {
                "minValue": "0",
                "maxValue": "100"
              }
            },
            "nodeChilds": []
          }
        ]
      }
    ]
  }
                
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.