Data Cloud Calculated Insights

Get calculated insights. Create a calculated insight.

Resource

1/ssot/calculated-insights

Available version

57.0

HTTP methods

GET, POST

Request parameters for GET

Parameter Name	Type	Description	Required or Optional	Available Version
`batchSize`	Integer	Number of items to return. Values are from 1–300. If unspecified, the default value is `25`.	Optional	57.0
`dataspace`	String	Name of the data space.	Optional	57.0
`definitionType`	String	Definition type of the calculated insight. Values are: `CalculatedMetric` `ExternalMetric` `StreamingMetric`	Optional	57.0
`offset`	Integer	Number of rows to skip before returning results. If unspecified, no rows are skipped.	Optional	57.0
`orderby`	String	Sort order for the result set, such as `GenderId__c ASC,Occupation__c DESC`. If unspecified, items are returned in the order they are retrieved.	Optional	57.0
`pageToken`	String	Specifies the page token to use to view a page of information. Page tokens are returned as part of the response, such as `currentPageToken` or `nextPageToken`. If you don’t specify a value, the first page is returned.	Optional	57.0

Response body for GET

Data Cloud Calculated Insight Collection

Request body for POST

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 POST

Data Cloud Calculated Insight

Connect REST API Developer Guide

Data Cloud Calculated Insights