User aggregates: Filter spec is a required query component

On https://developer.genesys.cloud/developer-tools/#/api-explorer, under /api/v2/analytics/users/aggregates/query the docs state:

filter ( #/definitions/UserAggregateQueryFilter, optional ): Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters

Note that this says "optional". However, if we call this endpoint with this payload:

{
"interval": "2021-05-04T00:00:00/2021-05-06T00:00:00",
"granularity": "P1D",
"groupBy": ["userId"],
"metrics": ["tSystemPresence"]
}

We get this error:
{
"message": "Filter spec is a required query component",
"code": "bad.request",
"status": 400,
"messageParams": {},
"contextId": "bd57b0c4-9e4a-4619-ac7c-59d42fe5a7dd",
"details": [],
"errors": []
}

Is the documentation simply incorrect and "filter" is actually required, or are we missing something here?

Hello,

Yes, filter is required.
It is mandatory to specify one or more userId in the request.
This method can't be used to query for user aggregates on all users (I mean not specifying a set of userIds).

Regards,

This topic was automatically closed 31 days after the last reply. New replies are no longer allowed.