Retrieve Aggregated Results for Configured Retrieval Summary Definition

Make a GET REST API request to retrieve aggregate records.

Available in: Lightning Experience

Available in: Professional, Enterprise, and Unlimited, Editions

User Permissions Needed
To configure Household API Setup:	Financial Services Cloud Extensions
To generate a Data Processing Engine definition for record aggregation:	Record Aggregation Access

The request includes two parameters:

The API Definition Name that was configured in the Create a Household API Using Configured Rollup Definitions. In the request, replace <APIDefinitionName> with the API Definition name
The ID of the Account or Party Relationship Group record. Replace <record ID> with the record ID of the record for which to show record results.

To visualize the aggregated records, send a request to the API. For example:

/services/data/v61.0/connect/retrieval-summary/runtime/<APIDefinitionName>/<record ID>

Did this article solve your issue?

Let us know so we can improve!

Product Area