CdpCalculatedInsight Class

Create, delete, get, run, and update Data 360 calculated insights.

ConnectApi

These methods are for CdpCalculatedInsight. All methods are static.

Create a calculated insight.

57.0

No

public static ConnectApi.CdpCalculatedInsightOutput createCalculatedInsight(ConnectApi.CdpCalculatedInsightInput input)

input

Type: ConnectApi.CdpCalculatedInsightInput

Input representation for a calculated insight.

shouldCommitTransaction

Type: Boolean

Indicates whether to commit the transaction (true) or not (false).

Type: ConnectApi.CdpCalculatedInsightOutput

Delete a calculated insight.

57.0

No

public static Void deleteCalculatedInsight(String apiName)

apiName

Type: String

API name of the calculated insight to delete.

shouldCommitTransaction

Type: Boolean

Indicates whether to commit the transaction (true) or not (false).

Type: Void

Get a calculated insight.

57.0

No

public static ConnectApi.CdpCalculatedInsightOutput getCalculatedInsight(String apiName)

apiName

Type: String

API name of the calculated insight to get.

Type: ConnectApi.CdpCalculatedInsightOutput

Get calculated insights.

56.0

No

public static ConnectApi.CdpCalculatedInsightPage getCalculatedInsights(String definitionType, Integer batchSize, Integer offset, String orderby, String dataspace)

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.

Type: ConnectApi.CdpCalculatedInsightPage

Get a page of calculated insights.

57.0

No

public static ConnectApi.CdpCalculatedInsightPage getCalculatedInsights(String definitionType, Integer batchSize, Integer offset, String orderby, String dataspace, String pageToken)

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.

Type: ConnectApi.CdpCalculatedInsightPage

Run a calculated insight.

57.0

No

public static ConnectApi.CdpCalculatedInsightStandardActionesponseRepresentation runCalculatedInsight(String apiName)

apiName

Type: String

API name of the calculated insight to run.

Type: ConnectApi.CdpCalculatedInsightStandardActionResponseRepresentation

Update a calculated insight.

57.0

No

public static ConnectApi.CdpCalculatedInsightOutput updateCalculatedInsight(String apiName, ConnectApi.CdpCalculatedInsightInput input)

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).

Type: ConnectApi.CdpCalculatedInsightOutput