GET /api/v1/insight/calculated-insights/(ci-name)
Use this API to query your Calculated Insights. Users can filter by selecting different dimensions, measures, and filters.
- HTTP method
GET
- Availability
Data Cloud v1.0, Salesforce v51.0
- Formats
REST
- URI
/api/v1/insight/calculated-insight/(ci-name)
| Field Name | Field Type | Description |
|---|---|---|
| ci_name | string | Required. The Calculated Insight name. |
| dimensions | string | Comma-separated list of dimensions to be projected. By default, this parameter includes all of the available dimensions. Example: GenderId__c |
| measures | string | Comma-separated list of measures to be projected. By default, this parameter includes all of the available measures. Example: TotalSales__c |
| limit | int | The number of items to return. By default, the maximum number, 4,999 items are returned. Example: 1,000 |
| offset | int | Number of rows to skip before starting to return. Example: 100 |
| filters | string | This parameter is added to a select query to select results of only a specific type. Example: [GenderId__c=Male,FirstName__c=Angel] |
| orderby | string | Comma-separated values to sort the result-set in ascending or descending order. Example: GenderId__c ASC, Occupation__c DESC |
| timeGranularity | string | With this parameter you can roll up the measures to various time ranges. Possible values: HOUR, DAY, MONTH, QUARTER, YEAR. This field is available in API version 53.0 and later. |
- Request
- Response
| Response | Reason |
|---|---|
| 200 OK | Callback successfully verified. |
| 400 Bad Request | Invalid request. |
| 403 Forbidden | Failed to pass authorization. |
| 404 Not Found | Incorrect callback ID, verification key, or both. |
| 422 Unprocessable Entity | The attribute name used in fields or filter parameters doesn’t exist. |
| 500 Server Error | Internal error. |