PlatformAggregateResponse
objectOne OfArray of CountResult (no query_type), TrendResult (trend), or TimeSeriesResult (time_series).
Current count for an entity type. Returned when query_type is omitted.
Show Child Parameters
PlatformCountResult
objectCurrent count for an entity type. Returned when query_type is omitted.
Present when group_by is specified.
Example:24
PlatformTrendResult
objectCurrent vs previous count for an entity type. Returned when query_type=trend.
Present when group_by is specified.
Example:24
Example:20
PlatformTimeSeriesResult
objectCumulative count of entities as of each time bucket. Returned when query_type=time_series.
Example:2026-01-04T00:00:00.000Z
Present when group_by is specified.
Total number of entities existing as of the end of this time bucket.
Example:11
Error
objectstandard error
The HTTP status code of the error. Useful when passing the response
body to child properties in a frontend UI. Must be returned as an integer.
A short, human-readable summary of the problem. It should not
change between occurences of a problem, except for localization.
Should be provided as “Sentence case” for direct use in the UI.
The error type.
Used to return the correlation ID back to the user, in the format
kong:trace:<correlation_id>. This helps us find the relevant logs
when a customer reports an issue.
A human readable explanation specific to this occurence of the problem.
This field may contain request/entity data to help the user understand
what went wrong. Enclose variable values in square brackets. Should be
provided as “Sentence case” for direct use in the UI.