Aggregate
Count, add up or average the objects a query finds, grouped by up to two fields, for dashboards and reports.
POST
Returns the count, the sum or the average of a query, optionally grouped by one or two fields.
A result with more than 50 groups on an axis names the 50 largest and gathers the rest into one group of kind
Scope
search:read and the scope of the kind of object. See the overview.Body parameters
string
default:""
The query that selects the objects.
object
default:"{ \"kind\": \"count\" }"
What to compute:
{ "kind": "count" }, or { "kind": "sum", "field": "estimate" } or { "kind": "avg", "field": "storyPoints" } over a number field. An average leaves objects without a value out.object[]
Up to two axes, each
{ "field": "status" }. A date field takes an interval of day, week (ISO week, starting Monday) or month, read in the time zone of the token owner.Response
object
required
other, always last.
Errors
Last modified on October 17, 2026