- Docs
- API reference
- Endpoints and schemas
- GraphQL
- Intent
aggregate
Counts the entities that match `searchInput`, and their related entities.
Intent. This intent is a read. It returns data and changes nothing.
Counts the entities that match searchInput, and their related entities. It returns the counts, not the entities. It does not accept prompt or dataLayer: UNGROUNDED.
Signature
Section titled “Signature”aggregate(searchInput: SearchInput!): AggregateResultReturns AggregateResult.
searchInput
Section titled “searchInput”A SearchInput. Its fields, and the part each one belongs to, are on its own page.
Example
Section titled “Example”query { aggregate(searchInput: { entityType: OPERATING_LOCATION conditions: { filter: { EQ: ["addresses.state", "TX"] } } }) { count(field: "operatingLocation") }}Response, as returned:
{ "data": { "aggregate": { "count": 2667674 } }}