Qodex.ai

getCalculatedInsights

GET {{baseUrl}}/ssot/calculated-insights

Get calculated insights in Data Cloud.

Available Version: 57.0

Request Params

KeyDatatypeRequiredDescription
batchSizestringNumber of items to return. Values are from 1-300. If unspecified, the default value is 25.

Available Version: 57.0 | | dataspace | string | | Name of the dataspace.

Available Version: 57.0 | | definitionType | string | | Definition type of the calculated insight. Values are:

  • CalculatedMetric
  • ExternalMetric
  • StreamingMetric

Available Version: 57.0 | | offset | string | | Number of rows to skip before returning results. If unspecified, no rows are skipped.

Available Version: 57.0 | | orderby | string | | Sort order for the result set, seuch as GenderId__c.ASC, Occupation__c.DESC. If unspecified, items are returned in the order they are retrieved.

Available Version: 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 unspecified, the first page is returned.

Available Version: 57.0 |

RESPONSES

status: OK

{"collection":{"count":"\u003cinteger\u003e","currentPageToken":"\u003cstring\u003e","currentPageUrl":"\u003cstring\u003e","items":[{"apiName":"\u003cstring\u003e","calculatedInsightStatus":"\u003cstring\u003e","creationType":"\u003cstring\u003e","dataSpace":"\u003cstring\u003e","definitionStatus":"\u003cstring\u003e","definitionType":"\u003cstring\u003e","description":"\u003cstring\u003e","dimensions":[{"apiName":"\u003cstring\u003e","creationType":"\u003cstring\u003e","dataSource":{"sourceApiName":"\u003cstring\u003e","type":"\u003cstring\u003e"},"dataType":"\u003cstring\u003e","dateGranularity":"\u003cstring\u003e","displayName":"\u003cstring\u003e","fieldRole":"\u003cstring\u003e","formula":"\u003cstring\u003e"},{"apiName":"\u003cstring\u003e","creationType":"\u003cstring\u003e","dataSource":{"sourceApiName":"\u003cstring\u003e","type":"\u003cstring\u003e"},"dataType":"\u003cstring\u003e","dateGranularity":"\u003cstring\u003e","displayName":"\u003cstring\u003e","fieldRole":"\u003cstring\u003e","formula":"\u003cstring\u003e"}],"displayName":"\u003cstring\u003e","expression":"\u003cstring\u003e","isEnabled":"\u003cboolean\u003e","lastCalcInsightStatusDateTime":"\u003cstring\u003e","lastCalcInsightStatusErrorCode":"\u003cstring\u003e","lastRunDateTime":"\u003cstring\u003e","lastRunStatus":"\u003cstring\u003e","lastRunStatusDateTime":"\u003cstring\u003e","lastRunStatusErrorCode":"\u003cstring\u003e","measures":[{"apiName":"\u003cstring\u003e","creationType":"\u003cstring\u003e","dataSource":{"sourceApiName":"\u003cstring\u003e","type":"\u003cstring\u003e"},"dataType":"\u003cstring\u003e","displayName":"\u003cstring\u003e","fieldAggregationType":"\u003cstring\u003e","fieldRole":"\u003cstring\u003e","formula":"\u003cstring\u003e"},{"apiName":"\u003cstring\u003e","creationType":"\u003cstring\u003e","dataSource":{"sourceApiName":"\u003cstring\u003e","type":"\u003cstring\u003e"},"dataType":"\u003cstring\u003e","displayName":"\u003cstring\u003e","fieldAggregationType":"\u003cstring\u003e","fieldRole":"\u003cstring\u003e","formula":"\u003cstring\u003e"}]},{"apiName":"\u003cstring\u003e","calculatedInsightStatus":"\u003cstring\u003e","creationType":"\u003cstring\u003e","dataSpace":"\u003cstring\u003e","definitionStatus":"\u003cstring\u003e","definitionType":"\u003cstring\u003e","description":"\u003cstring\u003e","dimensions":[{"apiName":"\u003cstring\u003e","creationType":"\u003cstring\u003e","dataSource":{"sourceApiName":"\u003cstring\u003e","type":"\u003cstring\u003e"},"dataType":"\u003cstring\u003e","dateGranularity":"\u003cstring\u003e","displayName":"\u003cstring\u003e","fieldRole":"\u003cstring\u003e","formula":"\u003cstring\u003e"},{"apiName":"\u003cstring\u003e","creationType":"\u003cstring\u003e","dataSource":{"sourceApiName":"\u003cstring\u003e","type":"\u003cstring\u003e"},"dataType":"\u003cstring\u003e","dateGranularity":"\u003cstring\u003e","displayName":"\u003cstring\u003e","fieldRole":"\u003cstring\u003e","formula":"\u003cstring\u003e"}],"displayName":"\u003cstring\u003e","expression":"\u003cstring\u003e","isEnabled":"\u003cboolean\u003e","lastCalcInsightStatusDateTime":"\u003cstring\u003e","lastCalcInsightStatusErrorCode":"\u003cstring\u003e","lastRunDateTime":"\u003cstring\u003e","lastRunStatus":"\u003cstring\u003e","lastRunStatusDateTime":"\u003cstring\u003e","lastRunStatusErrorCode":"\u003cstring\u003e","measures":[{"apiName":"\u003cstring\u003e","creationType":"\u003cstring\u003e","dataSource":{"sourceApiName":"\u003cstring\u003e","type":"\u003cstring\u003e"},"dataType":"\u003cstring\u003e","displayName":"\u003cstring\u003e","fieldAggregationType":"\u003cstring\u003e","fieldRole":"\u003cstring\u003e","formula":"\u003cstring\u003e"},{"apiName":"\u003cstring\u003e","creationType":"\u003cstring\u003e","dataSource":{"sourceApiName":"\u003cstring\u003e","type":"\u003cstring\u003e"},"dataType":"\u003cstring\u003e","displayName":"\u003cstring\u003e","fieldAggregationType":"\u003cstring\u003e","fieldRole":"\u003cstring\u003e","formula":"\u003cstring\u003e"}]}],"nextPageToken":"\u003cstring\u003e","nextPageUrl":"\u003cstring\u003e","previousPageToken":"\u003cstring\u003e","previousPageUrl":"\u003cstring\u003e","total":"\u003cinteger\u003e"}}