Retrieves DEX module configuration

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 configuration and feature status flags for the DEX module

Request URL

https://{serverurl}/intelligence/api/common/meta

Scope

DesktopCentralCloud.DEX.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

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

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomains/intelligence/api/common/meta \
  --header 'Accept: application/intelligenceMeta.v1+json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

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

Id of the insight ruleset

lastVisitedTargetJSON Object

Last visited target information

Show Sub-Attributes
customGroupIdstring

Id of the custom group last visited

remoteOfficeIdstring

Id of the remote office last visited

extensionStatusboolean

Status indicating if extensions are enabled

ziaChatBotStatusboolean

Status indicating if Zia chatbot is enabled

lastVisitedProfileIdstring

Id of the last visited score profile

timelineEnabledboolean

Status indicating if timeline feature is enabled

showOverviewIntroboolean

Flag to show or hide the overview intro

initialDataPreparedboolean

Status indicating if initial data has been prepared

isDeploymentEnabledboolean

Status indicating if deployment is enabled

isEIAgentInstalledboolean

Status indicating if DEX agent is installed

isSentimentScoreEnabledboolean

Status indicating if sentiment scoring is enabled

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Copied!
  {
    "rulesetId": "1",
    "lastVisitedTarget": {
      "customGroupId": "1"
    },
    "extensionStatus": true,
    "ziaChatBotStatus": true,
    "lastVisitedProfileId": "1",
    "timelineEnabled": false,
    "showOverviewIntro": false,
    "initialDataPrepared": true,
    "isDeploymentEnabled": true,
    "isEIAgentInstalled": true,
    "isSentimentScoreEnabled": true
  }
                
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.