---
title: "PlatformAggregateRequest"
url: "https://nov18-dev.movespot.fyi/apis/konnect-search-dev-1/versions/43a10fd2-5298-43cc-abd4-e0bd4176a167/schemas/PlatformAggregateRequest"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/konnect-search-dev-1/versions/43a10fd2-5298-43cc-abd4-e0bd4176a167.md

# PlatformAggregateRequest

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

## OpenAPI definition

```yaml
openapi: 3.0.2
info:
  title: Konnect Search
  version: 1.0.0
servers:
  - url: https://us.api.konghq.com/v1
    description: United-States Production region
  - url: https://eu.api.konghq.com/v1
    description: Europe Production region
  - url: https://au.api.konghq.com/v1
    description: Australia Production region
  - url: https://me.api.konghq.com/v1
    description: Middle-East Production region
  - url: https://in.api.konghq.com/v1
    description: India Production region
  - url: https://sg.api.konghq.com/v1
    description: Singapore Production region
  - url: https://global.api.konghq.com/v1
    description: Global Production
components:
  schemas:
    PlatformAggregateFilter:
      type: object
      properties:
        dimension:
          type: string
          enum:
            - control_plane
            - gateway_service
            - realm
            - plugin_name
            - plugin_scope
            - data_plane_node_version
        operator:
          type: string
          enum:
            - in
            - not_in
            - is_empty
            - is_not_empty
        value:
          description: Required for `in` and `not_in`. Not used for
            `is_empty`/`is_not_empty`.
          type: array
          items:
            type: string
      required:
        - dimension
        - operator
    PlatformAggregateRequest:
      description: |-
        **Pre-release Feature**
        This feature is currently in beta and is subject to change.
      type: object
      properties:
        entity_types:
          description: Entity types to count. When `group_by` is set, only one entity type
            is allowed.
          type: array
          items:
            type: string
            enum:
              - control_plane
              - gateway_service
              - route
              - consumer
              - plugin
              - data_plane_node
          minItems: 1
        query_type:
          description: >
            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.
          type: string
          enum:
            - trend
            - time_series
        start:
          description: Start of the time range (inclusive). Required when query_type is
            set. ISO 8601 UTC datetime.
          type: string
          format: date-time
          example: 2026-02-21T00:00:00.000Z
        end:
          description: End of the time range (inclusive). Required when query_type is set.
            ISO 8601 UTC datetime.
          type: string
          format: date-time
          example: 2026-03-23T00:00:00.000Z
        interval:
          description: Bucket interval. Required when query_type=time_series.
          type: string
          enum:
            - 1d
            - 1w
            - 1M
            - 1q
            - 1y
        group_by:
          description: >
            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.
          type: string
          enum:
            - control_plane
            - gateway_service
            - realm
            - plugin_name
            - plugin_scope
            - data_plane_node_version
        filters:
          description: Optional filters. Dimensions available for filtering match those
            available for group_by.
          type: array
          items:
            $ref: "#/components/schemas/PlatformAggregateFilter"
      required:
        - entity_types
```
