Apex Reference Guide
jNote: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.
CdpCalculatedInsight Class
Namespace
CdpCalculatedInsight Methods
createCalculatedInsight(input)
API Version
57.0
Requires Chatter
No
Signature
public static ConnectApi.CdpCalculatedInsightOutput createCalculatedInsight(ConnectApi.CdpCalculatedInsightInput input)
Parameters
- input
- Type: ConnectApi.CdpCalculatedInsightInput
- Input representation for a calculated insight.
- shouldCommitTransaction
- Type: Boolean
- Indicates whether to commit the transaction (true) or not (false).
Return Value
deleteCalculatedInsight(apiName)
API Version
57.0
Requires Chatter
No
Signature
public static Void deleteCalculatedInsight(String apiName)
Parameters
- apiName
- Type: String
- API name of the calculated insight to delete.
- shouldCommitTransaction
- Type: Boolean
- Indicates whether to commit the transaction (true) or not (false).
Return Value
Type: Void
getCalculatedInsight(apiName)
API Version
57.0
Requires Chatter
No
Signature
public static ConnectApi.CdpCalculatedInsightOutput getCalculatedInsight(String apiName)
Parameters
- apiName
- Type: String
- API name of the calculated insight to get.
Return Value
getCalculatedInsights(definitionType, batchSize, offset, orderby, dataspace)
API Version
56.0
Requires Chatter
No
Signature
public static ConnectApi.CdpCalculatedInsightPage getCalculatedInsights(String definitionType, Integer batchSize, Integer offset, String orderby, String dataspace)
Parameters
definitionType
Type: String
Definition type of the calculated insight. Values are:
- CALCULATED_METRIC
- CALCULATED_METRIC
- CALCULATED_METRIC
batchSize
Type: Integer
Number of items to return. Values are from 1–200. If unspecified, the default value is 25.
offset
Type: Integer
Number of rows to skip before returning results. If unspecified, no rows are skipped.
orderby
Type: 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.
dataspace
Type: String
Return Value
getCalculatedInsights(definitionType, batchSize, offset, orderby, dataspace, pageToken)
API Version
57.0
Requires Chatter
No
Signature
public static ConnectApi.CdpCalculatedInsightPage getCalculatedInsights(String definitionType, Integer batchSize, Integer offset, String orderby, String dataspace, String pageToken)
Parameters
definitionType
Type: String
Definition type of the calculated insight. Values are:
- CALCULATED_METRIC
- CALCULATED_METRIC
- CALCULATED_METRIC
batchSize
Type: Integer
Number of items to return. Values are from 1–200. If unspecified, the default value is 25.
offset
Type: Integer
Number of rows to skip before returning results. If unspecified, no rows are skipped.
orderby
Type: 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.
dataspace
Type: String
Name of the data space.
pageToken
Type: String
Specifies the page token to use to view a page of information. Page tokens are returned as part of the response class, such as currentPageToken or nextPageToken. If you pass in null, the first page is returned.
Return Value
runCalculatedInsight(apiName)
API Version
57.0
Requires Chatter
No
Signature
public static ConnectApi.CdpCalculatedInsightStandardActionesponseRepresentation runCalculatedInsight(String apiName)
Parameters
- apiName
- Type: String
- API name of the calculated insight to run.
Return Value
Type: ConnectApi.CdpCalculatedInsightStandardActionResponseRepresentation
updateCalculatedInsight(apiName, input)
API Version
57.0
Requires Chatter
No
Signature
public static ConnectApi.CdpCalculatedInsightOutput updateCalculatedInsight(String apiName, ConnectApi.CdpCalculatedInsightInput input)
Parameters
- apiName
- Type: String
- API name of the calculated insight to update.
- input
- Type: ConnectApi.CdpCalculatedInsightInput
- Input representation for a calculated insight.
- shouldCommitTransaction
- Type: Boolean
- Indicates whether to commit the transaction (true) or not (false).