Relationship Insights (GET, POST)
Generate or retrieve relationship insights for a Salesforce record. Use POST to start asynchronous relationship insight generation and GET to retrieve the latest available relationship insights for a Salesforce record or a specific relationship insight.
{yourInstance} is the domain name of your Salesforce instance.
67.0
GET, POST
| Parameter Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
graphFormat | String | Format of the returned relationship graph. Possible values are:
| Optional | 67.0 |
includeDiagnostics | Boolean | Indicates whether the response includes diagnostic information intended for debugging or administrative use (true) or not (false). The default is false. | Optional | 67.0 |
includeEvidence | Boolean | Indicates whether the response includes evidence objects (true) or not (false). The default is true. | Optional | 67.0 |
includeNotes | Boolean | Indicates whether the response includes relationship notes, if available (true) or not (false). The default is true. | Optional | 67.0 |
includeSensitiveEvidence | Boolean | Indicates whether the response includes evidence marked as sensitive when the current user has the required permission (true) or not (false). The default is false. | Optional | 67.0 |
includeSources | Boolean | Indicates whether the response includes source information (true) or not (false). The default is true. | Optional | 67.0 |
maxEvidencePerRelationship | Integer | Maximum number of evidence records to return for each relationship. The default limit is 3. | Optional | 67.0 |
maxRelationships | Integer | Maximum number of relationships to return after access filtering is applied. The default limit is 50. | Optional | 67.0 |
targetObject | String | API name of the target object type. If provided, the system validates that the record ID matches the specified object type. If omitted, the object type is derived from the record ID prefix. | Optional | 67.0 |
targetRecordId | String | Salesforce record ID to retrieve the latest available relationship insight for the record. | Optional | 67.0 |
| Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
generationOptions | Generation Options Input[] | Optional settings that influence data sources and generation behavior, such as enabling deep web search, using record context, or generating synthetic data for demonstrations. | Optional | 67.0 |
maxRelationships | Integer | Maximum number of relationships to retain in the generated insight graph. If not specified, the value defaults to the Relationship Research Agent configuration, for example, MAX_REL_PER_INSIGHT. | Optional | 67.0 |
regenerationMode | String | Regeneration strategy for relationship insights. Possible values include ALWAYS_REGENERATE, REFRESH_IF_EXPIRED, and REUSE_IF_FRESH. This setting controls whether an existing insight is reused or regenerated. | Optional | 67.0 |
requestMetadata | Map<String, Object> | Additional diagnostic or routing metadata, such as clientId or correlationId, used for observability, tracing, and debugging. | Optional | 67.0 |
targetObject | String | API name of the target SObject type, such as Opportunity. If not provided, the value is derived from targetRecordId. | Optional | 67.0 |
targetRecordId | String | Salesforce record ID for which relationship insights must be generated. For example, Opportunity, Account, Contact. | Required | 67.0 |
useCaseApiId | String | ID of the relationship research insight use case applied during insight generation. | Optional | 67.0 |
useCaseApiName | String | API name of the Relationship Research Agent use case configuration to apply. This value maps to the Template Config Definition in SDB. If not provided, the default org-level or object-level Relationship Research Agent configuration is used. | Optional | 67.0 |