getCalculatedInsightQuery

GET {{baseUrl}}/ssot/insight/calculated-insights/:ciName?batchSize=<integer>&dimensions=<string>&filters=<string>&measures=<string>&offset=<integer>&orderby=<string>&timeGranularity=<string>

Query a Calculated Insight object in Data Cloud.

Available Version: 52.0

Request Params

KeyDatatypeRequiredDescription
batchSizestringNumber of items to return. Values are from 1-4,999. If unspecified, the default value is 4999.

Available Version: 52.0 | | dimensions | string | | Comma-separated list of up to 10 dimensions, such as GenderId__c, to project. If unspecified, this parameter includes all of the available dimensions.

Available Version: 52.0 | | filters | string | | Filter the result set to a more narrow scope or specific type, such as [GenderId__c=Male,​FirstName__c=Angel].

Available Version: 52.0 | | measures | string | | Comma-separated list of up to 5 measures, such as TotalSales__c, to project. If unspecified, this parameter includes all of the available measures.

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

Available Version: 52.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.

Available Version: 52.0 | | timeGranularity | string | | Time range for the measures. Values are: HOUR, DAY, MONTH, QUARTER, or YEAR.

If unspecified, no time range is applied.

Available Version: 54.0 |

RESPONSES

status: OK

{&quot;done&quot;:&quot;\u003cboolean\u003e&quot;,&quot;endTime&quot;:&quot;\u003cstring\u003e&quot;,&quot;metadata&quot;:{&quot;//&quot;:&quot;\u003cobject\u003e&quot;},&quot;queryId&quot;:&quot;\u003cstring\u003e&quot;,&quot;rowCount&quot;:&quot;\u003cinteger\u003e&quot;,&quot;startTime&quot;:&quot;\u003cstring\u003e&quot;}