Aggregate platform entity counts

Returns aggregated entity counts for a Konnect org. Called by kAnalytics only.
kSearch owns all OpenSearch DSL construction internally.

post

Body

application/json

Platform aggregation request payload

PlatformAggregateRequest

Pre-release Feature
This feature is currently in beta and is subject to change.

entity_typesarray[string]required

Entity types to count. When group_by is set, only one entity type is allowed.

Allowed values:control_planegateway_servicerouteconsumerplugindata_plane_node

>= 1 items

query_typestring

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

startstring(date-time)

Start of the time range (inclusive). Required when query_type is set. ISO 8601 UTC datetime.

Example:2026-02-21T00:00:00.000Z

endstring(date-time)

End of the time range (inclusive). Required when query_type is set. ISO 8601 UTC datetime.

Example:2026-03-23T00:00:00.000Z

intervalstring

Bucket interval. Required when query_type=time_series.

Allowed values:1d1w1M1q1y

group_bystring

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

filtersarray[object]

Optional filters. Dimensions available for filtering match those available for group_by.

Show Child Parameters

Response

application/json

Aggregation results.

PlatformAggregateResponse

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
post/internal/aggregations/platform

Body

{ "entity_types": [ "control_plane", "gateway_service", "route", "consumer", "plugin" ] }
 
application/json

SearchCursorMeta

object

Pagination metadata.

pageobjectrequired
Show Child Parameters
Example

SearchCursorMetaPage

object
nextstring(path)

URI to the next page

sizenumberrequired

Requested page size

Example:10

Example

SearchResponse

object

Search response schema.

dataarray[object]

Item included in the list of search results.

Show Child Parameters
metaobject

Pagination metadata.

Show Child Parameters
Example

SearchResultItem

object

Item included in the list of search results.

idstringrequired

Unique identifier for the record.

typestringrequired

Konnect entity type.

namestringrequired

Name of the entity.

descriptionstring

Description of the entity.

labelsobject

Labels for the entity.

relationsobject

Relations for the entity.

attributesobject

Attributes for the entity.

matchstring

The matched text from the record.

relations_listarray[object]

The relations tree with child and sibling relations.

Show Child Parameters
Example