---
title: "Aggregate platform entity counts"
url: "https://nov18-dev.movespot.fyi/apis/konnect-search-dev-1/versions/43a10fd2-5298-43cc-abd4-e0bd4176a167/operations/post-search-aggregations-platform"
---

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

# Aggregate platform entity counts

`POST` `/internal/aggregations/platform`

Operation ID: `post-search-aggregations-platform`

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

## Request body (required)

Content types: `application/json`

## Responses

- `200` - Aggregation results.
- `400` - Bad Request
- `401` - Unauthorized
- `403` - Forbidden
- `404` - Not Found

## 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
paths:
  /internal/aggregations/platform:
    post:
      operationId: post-search-aggregations-platform
      summary: Aggregate platform entity counts
      description: >
        Returns aggregated entity counts for a Konnect org. Called by kAnalytics
        only.

        kSearch owns all OpenSearch DSL construction internally.
      requestBody:
        $ref: "#/components/requestBodies/PlatformAggregateRequest"
      responses:
        "200":
          $ref: "#/components/responses/PlatformAggregateResponse"
        "400":
          $ref: "#/components/responses/PlatformAggregateBadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
      tags:
        - Search
security:
  - personalAccessToken: []
  - systemAccountAccessToken: []
  - konnectAccessToken: []
components:
  requestBodies:
    PlatformAggregateRequest:
      description: Platform aggregation request payload
      required: true
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/PlatformAggregateRequest"
          examples:
            Count only (current totals):
              value:
                entity_types:
                  - control_plane
                  - gateway_service
                  - route
                  - consumer
                  - plugin
            Trend (stats grid):
              value:
                entity_types:
                  - control_plane
                  - gateway_service
                  - route
                  - consumer
                  - plugin
                query_type: trend
                start: 2026-02-21T00:00:00.000Z
                end: 2026-03-23T00:00:00.000Z
            Time series (weekly CP trend):
              value:
                entity_types:
                  - control_plane
                query_type: time_series
                start: 2026-02-21T00:00:00.000Z
                end: 2026-03-23T00:00:00.000Z
                interval: 1w
  responses:
    PlatformAggregateResponse:
      description: Aggregation results.
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/PlatformAggregateResponse"
    PlatformAggregateBadRequest:
      description: Bad Request
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/BadRequestError"
    Unauthorized:
      description: Unauthorized
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/UnauthorizedError"
          examples:
            UnauthorizedExample:
              $ref: "#/components/examples/UnauthorizedExample"
    Forbidden:
      description: Forbidden
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/ForbiddenError"
          examples:
            UnauthorizedExample:
              $ref: "#/components/examples/ForbiddenExample"
    NotFound:
      description: Not Found
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/NotFoundError"
          examples:
            NotFoundExample:
              $ref: "#/components/examples/NotFoundExample"
  schemas:
    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
    PlatformAggregateResponse:
      type: object
      properties:
        data:
          description: >
            Array of CountResult (no query_type), TrendResult (trend), or
            TimeSeriesResult (time_series).
          oneOf:
            - type: array
              items:
                $ref: "#/components/schemas/PlatformCountResult"
            - type: array
              items:
                $ref: "#/components/schemas/PlatformTrendResult"
            - type: array
              items:
                $ref: "#/components/schemas/PlatformTimeSeriesResult"
      required:
        - data
    BadRequestError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          required:
            - invalid_parameters
          properties:
            invalid_parameters:
              $ref: "#/components/schemas/InvalidParameters"
    UnauthorizedError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 401
            title:
              example: Unauthorized
            type:
              example: https://httpstatuses.com/401
            instance:
              example: kong:trace:1234567890
            detail:
              example: Invalid credentials
    ForbiddenError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 403
            title:
              example: Forbidden
            type:
              example: https://httpstatuses.com/403
            instance:
              example: kong:trace:1234567890
            detail:
              example: Forbidden
    NotFoundError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 404
            title:
              example: Not Found
            type:
              example: https://httpstatuses.com/404
            instance:
              example: kong:trace:1234567890
            detail:
              example: Not found
    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
    PlatformCountResult:
      description: Current count for an entity type. Returned when query_type is omitted.
      type: object
      properties:
        entity_type:
          type: string
        group_value:
          description: Present when group_by is specified.
          type: string
        count:
          type: integer
          example: 24
      required:
        - entity_type
        - count
    PlatformTrendResult:
      description: Current vs previous count for an entity type. Returned when
        query_type=trend.
      type: object
      properties:
        entity_type:
          type: string
        group_value:
          description: Present when group_by is specified.
          type: string
        current_count:
          type: integer
          example: 24
        previous_count:
          type: integer
          example: 20
      required:
        - entity_type
        - current_count
        - previous_count
    PlatformTimeSeriesResult:
      description: Cumulative count of entities as of each time bucket. Returned when
        query_type=time_series.
      type: object
      properties:
        timestamp:
          type: string
          format: date-time
          example: 2026-01-04T00:00:00.000Z
        group_value:
          description: Present when group_by is specified.
          type: string
        count:
          description: Total number of entities existing as of the end of this time bucket.
          type: integer
          example: 11
      required:
        - timestamp
        - count
    BaseError:
      description: standard error
      type: object
      properties:
        status:
          description: >
            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.
          type: integer
          readOnly: true
        title:
          description: |
            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.
          type: string
          readOnly: true
        type:
          description: The error type.
          type: string
          readOnly: true
        instance:
          description: |
            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.
          type: string
          readOnly: true
        detail:
          description: >
            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.
          type: string
          readOnly: true
      required:
        - status
        - title
        - instance
        - detail
      title: Error
    InvalidParameters:
      description: invalid parameters
      type: array
      items:
        oneOf:
          - $ref: "#/components/schemas/InvalidParameterStandard"
          - $ref: "#/components/schemas/InvalidParameterMinimumLength"
          - $ref: "#/components/schemas/InvalidParameterMaximumLength"
          - $ref: "#/components/schemas/InvalidParameterChoiceItem"
          - $ref: "#/components/schemas/InvalidParameterDependentItem"
      minItems: 1
      nullable: false
      uniqueItems: true
    InvalidParameterStandard:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          $ref: "#/components/schemas/InvalidRules"
        source:
          type: string
          example: body
        reason:
          type: string
          example: is a required field
          readOnly: true
      additionalProperties: false
      required:
        - field
        - reason
    InvalidParameterMinimumLength:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - min_length
            - min_digits
            - min_lowercase
            - min_uppercase
            - min_symbols
            - min_items
            - min
          nullable: false
          readOnly: true
        minimum:
          type: integer
          example: 8
        source:
          type: string
          example: body
        reason:
          type: string
          example: must have at least 8 characters
          readOnly: true
      additionalProperties: false
      required:
        - field
        - reason
        - rule
        - minimum
    InvalidParameterMaximumLength:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - max_length
            - max_items
            - max
          nullable: false
          readOnly: true
        maximum:
          type: integer
          example: 8
        source:
          type: string
          example: body
        reason:
          type: string
          example: must not have more than 8 characters
          readOnly: true
      additionalProperties: false
      required:
        - field
        - reason
        - rule
        - maximum
    InvalidParameterChoiceItem:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - enum
          nullable: false
          readOnly: true
        reason:
          type: string
          example: is a required field
          readOnly: true
        choices:
          type: array
          items: {}
          minItems: 1
          nullable: false
          readOnly: true
          uniqueItems: true
        source:
          type: string
          example: body
      additionalProperties: false
      required:
        - field
        - reason
        - rule
        - choices
    InvalidParameterDependentItem:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - dependent_fields
          nullable: true
          readOnly: true
        reason:
          type: string
          example: is a required field
          readOnly: true
        dependents:
          type: array
          items: {}
          nullable: true
          readOnly: true
          uniqueItems: true
        source:
          type: string
          example: body
      additionalProperties: false
      required:
        - field
        - rule
        - reason
        - dependents
    InvalidRules:
      description: invalid parameters rules
      type: string
      enum:
        - required
        - is_array
        - is_base64
        - is_boolean
        - is_date_time
        - is_integer
        - is_null
        - is_number
        - is_object
        - is_string
        - is_uuid
        - is_fqdn
        - is_arn
        - unknown_property
        - missing_reference
        - is_label
        - matches_regex
        - invalid
        - is_supported_network_availability_zone_list
        - is_supported_network_cidr_block
        - is_supported_provider_region
        - type
      nullable: true
      readOnly: true
  examples:
    UnauthorizedExample:
      value:
        status: 401
        title: Unauthorized
        instance: kong:trace:8347343766220159418
        detail: Unauthorized
    ForbiddenExample:
      value:
        status: 403
        title: Forbidden
        instance: kong:trace:2723154947768991354
        detail: You do not have permission to perform this action
    NotFoundExample:
      value:
        status: 404
        title: Not Found
        instance: kong:trace:6816496025408232265
        detail: Not Found
  securitySchemes:
    personalAccessToken:
      type: http
      scheme: bearer
      bearerFormat: Token
      description: >
        The personal access token is meant to be used as an alternative to
        basic-auth when accessing Konnect via APIs.

        You can generate a Personal Access Token (PAT) from the [personal access
        token page](https://cloud.konghq.com/global/account/tokens/) in the
        Konnect dashboard.

        The PAT token must be passed in the header of a request, for example:

        `curl -X GET 'https://global.api.konghq.com/v2/users/' --header
        'Authorization: Bearer kpat_xgfT...'`
    systemAccountAccessToken:
      type: http
      scheme: bearer
      bearerFormat: Token
      description: >
        The system account access token is meant for automations and
        integrations that are not directly associated with a human identity.

        You can generate a system account Access Token by creating a system
        account and then obtaining a system account access token for that
        account.

        The access token must be passed in the header of a request, for example:

        `curl -X GET 'https://global.api.konghq.com/v2/users/' --header
        'Authorization: Bearer spat_i2Ej...'`
    konnectAccessToken:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        The Konnect access token is meant to be used by the Konnect dashboard
        and the decK CLI authenticate with.
```
