Retrieves calculated insights for a specific profile record. This endpoint allows you to access computed attributes and metrics related to the profile.
Syntax
- HTTP Method: GET
- Availability: Data 360 v1.0, Salesforce v51.0
- format: REST
- URI:
/api/v1/profile/{dataModelName}/{Id}/calculated-insights/{ci-name}
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| dataModelName | string | Required. The unique identifier of the data model object. Example: Individual__dlm |
| Id | string | Required. The unique identifier of the record. Example: 123 |
| ci-name | string | Required. The unique identifier of the calculated insight. Example: TotalSales__cio |
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| fields | string | Comma-separated list of fields to include in the response. Example: TotalAmount__c,LastPurchaseDate__c |
Response Structure
The response includes:
data: Array of record objects containing the requested datadone: boolean indicating if all results have been returned
Examples
Request
GET https://{TSE}.360a.salesforce.com/api/v1/profile/Individual__dlm/123/calculated-insights/TotalSales__cio?fields=TotalAmount__c,LastPurchaseDate__c
Response
{
"data": [
{
"TotalAmount__c": 1500.0,
"LastPurchaseDate__c": "2024-03-15T10:30:00Z"
}
],
"done": true
}
Notes
- You must explicitly specify fields to retrieve more than 10 fields
- The record ID must be a valid identifier in the data model object
- The calculated insight must be associated with the data model object
- The response includes only the specified fields
- If no fields are specified, up to 10 fields are returned