Summarize Query

The SummarizeQuery RPC is available for both the Entity Management and Event Management services. The behavior is identical between the two; this document describes them together. Where a distinction exists, it will be called out explicitly.

Overview

SummarizeQuery lets you compute numeric summaries — count, min, max, average, and sum — across a filtered set of resources, entities, or events. Results can be sliced into groups using property values, relationship targets, or an externally supplied relationship map. For events, a common pattern is to group summaries by the parent entity — for example, rolling up event totals per entity. The response always shares the same shape regardless of how the data was grouped.

Conceptual model

Think of SummarizeQuery as a single-pass GROUP BY + summarize pipeline:

FILTER resources
→ GROUP BY (properties and/or relationships)
→ SUMMARIZE (count, min, max, avg, sum) on specified numeric properties
→ RETURN one ResourceSummary per group, with errors for anything that couldn't be computed

A minimal request needs at least one property to summarize and at least one filter. Everything else is optional.