Data Cloud Calculated Insight

Get, update, or delete a calculated insight.

Resource

1/ssot/calculated-insights/apiName

Available version

57.0

HTTP methods

GET, PATCH, DELETE

Response body for GET

Data Cloud Calculated Insight

Request body for PATCH

Data Cloud Calculated Insight Input

Root XML tag

<cdpCalculatedInsightInput>

JSON example

1{
2"displayName": "dev1__demo_draft_ci_6__cio",
3"apiName": "dev1__demo_draft_ci_6__cio",
4"definitionType": "CalculatedMetric",
5"expression": "SELECT count(ssot__Individual__dlm.ssot__DataSourceId__c) as dev1__m1__c, ssot__Individual__dlm.ssot__Id__c as dev1__d1__c FROM ssot__Individual__dlm WHERE ssot__Individual__dlm.ssot__InternalOrganizationId__c= 'test name' GROUP BY dev1__d1__c",
6"draft": true
7}

Properties

Name	Type	Description	Required or Optional	Available Version
`apiName`	String	API name of the calculated insight with suffix __cio.	Required for POST Optional for PATCH	57.0
`createdFromPackage`	Boolean	Specifies whether the calculated insight was created from an installed package (`true`) or not (`false`).	Optional	57.0
`dataSpaceName`	String	Name of the data space.	Optional	57.0
`definitionType`	String	Definition type of the calculated insight. Values are: `CalculatedMetric` `ExternalMetric` `StreamingMetric`	Required for POST Optional for PATCH	57.0
`description`	String	Calculated insight description.	Optional	57.0
`displayName`	String	Calculated insight display name.	Required for POST Optional for PATCH	57.0
`draft`	Boolean	Specifies whether to save the calculated insight as draft (`true`) or not (`false`).	Optional	57.0
`expression`	String	Calculated insight ANSI SQL expression.	Required for POST Optional for PATCH	57.0
`packagedCalculatedInsightApiName`	String	API name of the packaged calculated insight.	Optional	57.0

Response body for PATCH

Data Cloud Calculated Insight

Response for DELETE

204: Successful Delete

Connect REST API Developer Guide

Data Cloud Calculated Insight