Relation
objectThe type of the related entity.
The unique identifier of the related entity.
The child relations of the related entity.
Show Child Parameters
PlatformAggregateRequest
objectPre-release Feature
This feature is currently in beta and is subject to change.
Entity types to count. When group_by is set, only one entity type is allowed.
Allowed values:control_planegateway_servicerouteconsumerplugindata_plane_node
>= 1 items
Optional. When omitted, returns current counts only (no comparison or time bucketing).
When trend, start and end are required. When time_series, start, end, and interval are required.
Allowed values:trendtime_series
Start of the time range (inclusive). Required when query_type is set. ISO 8601 UTC datetime.
Example:2026-02-21T00:00:00.000Z
End of the time range (inclusive). Required when query_type is set. ISO 8601 UTC datetime.
Example:2026-03-23T00:00:00.000Z
Bucket interval. Required when query_type=time_series.
Allowed values:1d1w1M1q1y
Dimension to group results by. Available dimensions depend on entity_type:
control_plane → (none), gateway_service → control_plane,
route → control_plane | gateway_service,
consumer → control_plane | realm,
plugin → control_plane | plugin_name | plugin_scope,
data_plane_node → control_plane | data_plane_node_version.
Allowed values:control_planegateway_servicerealmplugin_nameplugin_scopedata_plane_node_version
Optional filters. Dimensions available for filtering match those available for group_by.
Show Child Parameters
PlatformAggregateFilter
objectAllowed values:control_planegateway_servicerealmplugin_nameplugin_scopedata_plane_node_version
Allowed values:innot_inis_emptyis_not_empty
Required for in and not_in. Not used for is_empty/is_not_empty.
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