Entity counting
- Last UpdatedNov 02, 2026
- 1 minute read
Use countEntities to retrieve the total entity count and a count grouped by entity class without requesting individual entity payloads. Use summary and aggregation instead when you need filtering, grouping by properties or relationships, or numeric property aggregates.
Query signature
countEntities: EntityCountResult
countEntities does not accept filter arguments. It returns:
-
entityCount: total entity count.
-
classCounts: count entries containing classId, className, and count.
-
responseContext: request metadata, including requestTime.
Total count
query {
countEntities {
entityCount
}
}
Count by class
query {
countEntities {
entityCount
classCounts {
classId
className
count
}
responseContext {
requestTime
}
}
}
Example response shape:
{
"data": {
"countEntities": {
"entityCount": 1250,
"classCounts": [
{
"classId": 0,
"className": null,
"count": 25
},
{
"classId": 12,
"className": "Equipment",
"count": 1225
}
],
"responseContext": {
"requestTime": "2026-08-28T16:00:00Z"
}
}
}
}
Client guidance
-
Do not rely on the order of classCounts entries. Identify a class by its classId or className.
-
Fields in a class-count entry can be null, as defined by the schema. Handle null count, classId, and className values.
-
Class ID 0 represents unassigned entities; its className is not guaranteed and can be null.