Apex Reference Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Apex Reference Guide
Release Notes
Apex DML Operations
ApexPages Namespace
AppLauncher Namespace
Approval Namespace
Auth Namespace
Cache Namespace
Canvas Namespace
ChatterAnswers Namespace
CommerceExtension Namespace
CommerceOrders Namespace
CommercePayments Namespace
CommerceTax Namespace
Compression Namespace
ConnectApi Namespace
ActionLinks Class
Announcements Class
BotVersionActivation Class
CdpCalculatedInsight Class
CdpCalculatedInsight Methods
CdpIdentityResolution Class
CdpQuery Class
CdpSegment Class
Chatter Class
ChatterFavorites Class
ChatterFeeds Class
ChatterGroups Class
ChatterMessages Class
ChatterUsers Class
Clm Class
CommerceBuyerExperience Class
CommerceCart Class
CommerceCatalog Class
CommerceCatalogManagement Class
CommercePromotions Class
CommerceSearch Class
CommerceSearchConnectFamily Class
CommerceSearchSettings Class
CommerceStorePricing Class
CommerceWishlist Class
Communities Class
CommunityModeration Class
ContentHub Class
ConversationApplicationDefinition Class
Datacloud Class
EinsteinLLM Class
EmailMergeFieldService Class
EmployeeProfiles Class
Exchanges Class
ExtendedCommerceDelivery Class
ExternalEmailServices Class
ExternalManagedAccount Class
FieldService Class
FulfillmentOrder Class
Knowledge Class
LightningScheduler Class
ManagedContent Class
ManagedContentChannels Class
ManagedContentDelivery Class
ManagedContentSpaces Class
ManagedTopics Class
MarketingIntegration Class
Mentions Class
Missions Class
NamedCredentials Class
NavigationMenu Class
NextBestAction Class
OmnichannelInventoryService Class
OMSAnalytics Class
Orchestration Class
OrderPaymentSummary Class
OrderSummary Class
OrderSummaryCreation Class
Organization Class
PardotBusinessUnitContext Class
Payments Class
Personalization Class
PickTicket Class
QuestionAndAnswers Class
Recommendations Class
Records Class
RegisterGuestBuyer Class
Repricing Class
ReturnOrder Class
Routing Class
SalesforceInbox Class
Search Class
Sites Class
SmartDataDiscovery Class
SocialEngagement Class
Surveys Class
TaxPlatform Class
Topics Class
UserProfiles Class
Zones Class
ConnectApi Input Classes
ConnectApi Output Classes
ConnectApi Enums
ConnectApi Exceptions
ConnectApi Utilities
ConnectApi Release Notes
Context Namespace
Database Namespace
Datacloud Namespace
DataRetrieval Namespace
DataSource Namespace
DataWeave Namespace
Dom Namespace
EventBus Namespace
ExternalService Namespace
Flow Namespace
FormulaEval Namespace
fsccashflow Namespace
Functions Namespace
industriesNlpSvc
IndustriesDigitalLending Namespace
Invocable Namespace
IsvPartners Namespace
KbManagement Namespace
LxScheduler Namespace
Messaging Namespace
Metadata Namespace
PlaceQuote Namespace
Pref_center Namespace
Process Namespace
QuickAction Namespace
Reports Namespace
RevSalesTrxn Namespace
RichMessaging Namespace
Salesforce_Backup Namespace
Schema Namespace
Search Namespace
Sfc Namespace
Sfdc_Checkout Namespace
Sfdc_Enablement Namespace
sfdc_surveys Namespace
Site Namespace
Slack Namespace
Support Namespace
System Namespace
TerritoryMgmt Namespace
TxnSecurity Namespace
UserProvisioning Namespace
VisualEditor Namespace
Wave Namespace
Appendices
PDF

CdpCalculatedInsight Class

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

Namespace

ConnectApi

CdpCalculatedInsight Methods

These methods are for CdpCalculatedInsight. All methods are static.

createCalculatedInsight(input)

Create a calculated insight.

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.

Return Value

Type: ConnectApi.CdpCalculatedInsightOutput

deleteCalculatedInsight(apiName)

Delete a calculated insight.

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.

Return Value

Type: Void

getCalculatedInsight(apiName)

Get a calculated insight.

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

Type: ConnectApi.CdpCalculatedInsightOutput

getCalculatedInsights(definitionType, batchSize, offset, orderby, dataspace)

Get calculated insights.

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
Name of the data space.

Return Value

Type: ConnectApi.CdpCalculatedInsightPage

getCalculatedInsights(definitionType, batchSize, offset, orderby, dataspace, pageToken)

Get a page of calculated insights.

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

Type: ConnectApi.CdpCalculatedInsightPage

runCalculatedInsight(apiName)

Run a calculated insight.

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)

Update a calculated insight.

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.

Return Value

Type: ConnectApi.CdpCalculatedInsightOutput