Skip to main content
POST
Group and count inventory transactions

Authorizations

X-API-Key
string
header
required

Organization-scoped API key. Create one in the BuildingSwell app under Organization settings, API keys.

Body

application/json
groupByField
required

Field to group by, or several fields for a compound grouping. Nested paths work, for example computed.projectId.

unnestGroupByField
boolean

Set this when grouping by an array field, such as computed.tags, to count each value separately instead of counting whole arrays.

Response

Successful response.

values
object[]

One row per group.

hasMore
boolean

true when another page is available.