Request aggregation

Send a request aggregation query and return the aggregation result

Body required
application/json

The request aggregation query

query
string | null

The HRQL query to use for the search, represents the way to filter requests. If not specified, it will filter nothing
groupBy
array of string | null

The field that the aggregation will take place on
withCount
boolean | null

If set to true, the total count of requests matching the HRQL query will be returned
sortOrder
string | null
Enum Asc Desc KeyAsc KeyDesc
limit
integer | null

In case of an aggregate sending a lot of different results, how many must be sent back
having
object | null (Having)

A condition to apply to the result. Only the aggregates results with more than 5 requests in them can be kept for example
scope
string | null

The scope of the aggregate. manage only aggregates among requests that the currently logged in user has the rights to manage. search aggregates among all visible requests to the logged in user. self aggregates among requests that the currently logged in user or its team has issued

Enum manage search self
Responses
  • 200 The aggregation result
    items
    array of object required

    All the groups in this aggregate
    count
    integer | null

    The total number of requests matching the query
  • 400 Invalid request
  • 401 Unauthorized request
  • 403 Forbidden action
  • 500 Internal server error