GET /api/v1/insight/calculated-insights/{ci-name}
Queries a specific calculated insight in your Data Cloud instance. This endpoint allows you to retrieve data with customizable dimensions, measures, filters, and time-based aggregations.
- HTTP Method: GET
- Availability: Data Cloud v1.0, Salesforce v51.0
- Format: REST
- URI:
/api/v1/insight/calculated-insights/{ci-name}
| Parameter | Type | Description |
|---|---|---|
| ci-name | string | Required. The unique identifier of the calculated insight. Example: Avg_Spends__cio |
| Parameter | Type | Description |
|---|---|---|
| dimensions | string | Comma-separated list of dimensions to include in the response. Default: all available dimensions. Example: GenderId__c,FirstName__c |
| measures | string | Comma-separated list of measures to include in the response. Default: all available measures. Example: TotalSales__c,AvgSpend__c |
| limit | integer | Maximum number of rows to return. Default: 4,999. Example: 1000 |
| offset | integer | Number of rows to skip before returning results. Example: 100 |
| filters | string | Filter criteria in the format [field=value]. Example: [GenderId__c=Male,FirstName__c=John] |
| orderby | string | Comma-separated list of fields to sort by, with optional direction (ASC/DESC). Example: GenderId__c ASC,Occupation__c DESC |
| timeGranularity | string | Time-based aggregation level. Available in API v53.0+. Values: HOUR, DAY, MONTH, QUARTER, YEAR |
The response includes:
data: Array of objects containing the requested dimensions and measuresdone: Boolean indicating if all results have been returned
- Use pagination (limit/offset) for retrieving large datasets
- Time-based aggregation is only available in API version 53.0 and later
- Filter values are case-sensitive
- The orderby parameter supports multiple fields with different sort directions