PlatformAggregateResponse

object
dataOne Of
required

Array of CountResult (no query_type), TrendResult (trend), or TimeSeriesResult (time_series).

PlatformCountResultarray[object]

Current count for an entity type. Returned when query_type is omitted.

Show Child Parameters
Example

PlatformCountResult

object

Current count for an entity type. Returned when query_type is omitted.

entity_typestringrequired
group_valuestring

Present when group_by is specified.

countintegerrequired

Example:24

Example

PlatformTrendResult

object

Current vs previous count for an entity type. Returned when query_type=trend.

entity_typestringrequired
group_valuestring

Present when group_by is specified.

current_countintegerrequired

Example:24

previous_countintegerrequired

Example:20

Example

PlatformTimeSeriesResult

object

Cumulative count of entities as of each time bucket. Returned when query_type=time_series.

timestampstring(date-time)required

Example:2026-01-04T00:00:00.000Z

group_valuestring

Present when group_by is specified.

countintegerrequired

Total number of entities existing as of the end of this time bucket.

Example:11

Example

Error

object

standard error

statusintegerrequiredread-only

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.

titlestringrequiredread-only

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.

typestringread-only

The error type.

instancestringrequiredread-only

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.

detailstringrequiredread-only

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.

Example