---
title: "AdvancedFilters"
url: "https://nov18-dev.movespot.fyi/apis/konnect-metrics-endpoint-4/versions/067cb7dd-3237-4170-bfaf-95928b927e78/schemas/AdvancedFilters"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/konnect-metrics-endpoint-4/versions/067cb7dd-3237-4170-bfaf-95928b927e78.md

# AdvancedFilters

A list of filters to apply to the query.

## OpenAPI definition

```yaml
openapi: 3.0.2
info:
  title: Konnect Metrics Endpoint
  version: 4.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
components:
  schemas:
    MetricsApiFilterByField:
      oneOf:
        - title: Multiselect filters
          type: object
          properties:
            operator:
              $ref: "#/components/schemas/RequestsFilterType"
            value:
              description: |
                The IDs to include in the results.
              type: array
              items:
                $ref: "#/components/schemas/UnscopedUuid"
            field:
              description: The field to filter.
              type: string
              enum:
                - api
          required:
            - operator
            - value
            - field
        - title: Empty filters
          type: object
          properties:
            operator:
              $ref: "#/components/schemas/RequestsFilterTypeEmpty"
            field:
              description: The field to filter.
              type: string
              enum:
                - api
          required:
            - operator
            - field
      title: Filter by api
    MetricsApiPackageFilterByField:
      oneOf:
        - title: Multiselect filters
          type: object
          properties:
            operator:
              $ref: "#/components/schemas/RequestsFilterType"
            value:
              description: |
                The IDs to include in the results.
              type: array
              items:
                $ref: "#/components/schemas/UnscopedUuid"
            field:
              description: The field to filter.
              type: string
              enum:
                - api_package
          required:
            - operator
            - value
            - field
        - title: Empty filters
          type: object
          properties:
            operator:
              $ref: "#/components/schemas/RequestsFilterTypeEmpty"
            field:
              description: The field to filter.
              type: string
              enum:
                - api_package
          required:
            - operator
            - field
      title: Filter by api_package
    MetricsApiProductFilterByField:
      oneOf:
        - title: Multiselect filters
          type: object
          properties:
            operator:
              $ref: "#/components/schemas/RequestsFilterType"
            value:
              description: |
                The IDs to include in the results.
              type: array
              items:
                $ref: "#/components/schemas/UnscopedUuid"
            field:
              description: The field to filter.
              type: string
              enum:
                - api_product
          required:
            - operator
            - value
            - field
        - title: Empty filters
          type: object
          properties:
            operator:
              $ref: "#/components/schemas/RequestsFilterTypeEmpty"
            field:
              description: The field to filter.
              type: string
              enum:
                - api_product
          required:
            - operator
            - field
      title: Filter by api_product
    MetricsApiProductVersionFilterByField:
      oneOf:
        - title: Multiselect filters
          type: object
          properties:
            operator:
              $ref: "#/components/schemas/RequestsFilterType"
            value:
              description: |
                The IDs to include in the results.
              type: array
              items:
                $ref: "#/components/schemas/UnscopedUuid"
            field:
              description: The field to filter.
              type: string
              enum:
                - api_product_version
          required:
            - operator
            - value
            - field
        - title: Empty filters
          type: object
          properties:
            operator:
              $ref: "#/components/schemas/RequestsFilterTypeEmpty"
            field:
              description: The field to filter.
              type: string
              enum:
                - api_product_version
          required:
            - operator
            - field
      title: Filter by api_product_version
    MetricsApplicationFilterByField:
      oneOf:
        - title: Multiselect filters
          type: object
          properties:
            operator:
              $ref: "#/components/schemas/RequestsFilterType"
            value:
              description: |
                The IDs to include in the results.
              type: array
              items:
                $ref: "#/components/schemas/UnscopedUuid"
            field:
              description: The field to filter.
              type: string
              enum:
                - application
          required:
            - operator
            - value
            - field
        - title: Empty filters
          type: object
          properties:
            operator:
              $ref: "#/components/schemas/RequestsFilterTypeEmpty"
            field:
              description: The field to filter.
              type: string
              enum:
                - application
          required:
            - operator
            - field
      title: Filter by application
    MetricsConsumerFilterByField:
      oneOf:
        - title: Multiselect filters
          type: object
          properties:
            operator:
              $ref: "#/components/schemas/RequestsFilterType"
            value:
              description: >
                The IDs to include in the results. Because gateway IDs are only
                unique within a given control plane, the filter values must be
                of the form `control_plane_id:field_id` or
                `control_plane_group_id:field_id` for data plane nodes within a
                control plane group.
              type: array
              items:
                $ref: "#/components/schemas/ScopedUuid"
            field:
              description: The field to filter.
              type: string
              enum:
                - consumer
          required:
            - operator
            - value
            - field
        - title: Empty filters
          type: object
          properties:
            operator:
              $ref: "#/components/schemas/RequestsFilterTypeEmpty"
            field:
              description: The field to filter.
              type: string
              enum:
                - consumer
          required:
            - operator
            - field
      title: Filter by consumer
    MetricsControlPlaneFilterByField:
      oneOf:
        - title: Multiselect filters
          type: object
          properties:
            operator:
              $ref: "#/components/schemas/RequestsFilterType"
            value:
              description: |
                The IDs to include in the results.
              type: array
              items:
                $ref: "#/components/schemas/UnscopedUuid"
            field:
              description: The field to filter.
              type: string
              enum:
                - control_plane
          required:
            - operator
            - value
            - field
        - title: Empty filters
          type: object
          properties:
            operator:
              $ref: "#/components/schemas/RequestsFilterTypeEmpty"
            field:
              description: The field to filter.
              type: string
              enum:
                - control_plane
          required:
            - operator
            - field
      title: Filter by control_plane
    MetricsControlPlaneGroupFilterByField:
      oneOf:
        - title: Multiselect filters
          type: object
          properties:
            operator:
              $ref: "#/components/schemas/RequestsFilterType"
            value:
              description: |
                The IDs to include in the results.
              type: array
              items:
                $ref: "#/components/schemas/UnscopedUuid"
            field:
              description: The field to filter.
              type: string
              enum:
                - control_plane_group
          required:
            - operator
            - value
            - field
        - title: Empty filters
          type: object
          properties:
            operator:
              $ref: "#/components/schemas/RequestsFilterTypeEmpty"
            field:
              description: The field to filter.
              type: string
              enum:
                - control_plane_group
          required:
            - operator
            - field
      title: Filter by control_plane_group
    MetricsCountryCodeFilterByField:
      oneOf:
        - title: Multiselect filters
          type: object
          properties:
            operator:
              $ref: "#/components/schemas/RequestsFilterType"
            value:
              description: |
                The values to include in the results.
              type: array
              items:
                type: string
            field:
              description: The field to filter.
              type: string
              enum:
                - country_code
          required:
            - operator
            - value
            - field
        - title: Empty filters
          type: object
          properties:
            operator:
              $ref: "#/components/schemas/RequestsFilterTypeEmpty"
            field:
              description: The field to filter.
              type: string
              enum:
                - country_code
          required:
            - operator
            - field
      title: Filter by country_code
    MetricsDataPlaneNodeFilterByField:
      oneOf:
        - title: Multiselect filters
          type: object
          properties:
            operator:
              $ref: "#/components/schemas/RequestsFilterType"
            value:
              description: >
                The IDs to include in the results. Because gateway IDs are only
                unique within a given control plane, the filter values must be
                of the form `control_plane_id:field_id` or
                `control_plane_group_id:field_id` for data plane nodes within a
                control plane group.
              type: array
              items:
                $ref: "#/components/schemas/ScopedUuid"
            field:
              description: The field to filter.
              type: string
              enum:
                - data_plane_node
          required:
            - operator
            - value
            - field
        - title: Empty filters
          type: object
          properties:
            operator:
              $ref: "#/components/schemas/RequestsFilterTypeEmpty"
            field:
              description: The field to filter.
              type: string
              enum:
                - data_plane_node
          required:
            - operator
            - field
      title: Filter by data_plane_node
    MetricsDataPlaneNodeVersionFilterByField:
      oneOf:
        - title: Multiselect filters
          type: object
          properties:
            operator:
              $ref: "#/components/schemas/RequestsFilterType"
            value:
              description: |
                The values to include in the results.
              type: array
              items:
                type: string
            field:
              description: The field to filter.
              type: string
              enum:
                - data_plane_node_version
          required:
            - operator
            - value
            - field
        - title: Empty filters
          type: object
          properties:
            operator:
              $ref: "#/components/schemas/RequestsFilterTypeEmpty"
            field:
              description: The field to filter.
              type: string
              enum:
                - data_plane_node_version
          required:
            - operator
            - field
      title: Filter by data_plane_node_version
    MetricsGatewayServiceFilterByField:
      oneOf:
        - title: Multiselect filters
          type: object
          properties:
            operator:
              $ref: "#/components/schemas/RequestsFilterType"
            value:
              description: >
                The IDs to include in the results. Because gateway IDs are only
                unique within a given control plane, the filter values must be
                of the form `control_plane_id:field_id` or
                `control_plane_group_id:field_id` for data plane nodes within a
                control plane group.
              type: array
              items:
                $ref: "#/components/schemas/ScopedUuid"
            field:
              description: The field to filter.
              type: string
              enum:
                - gateway_service
          required:
            - operator
            - value
            - field
        - title: Empty filters
          type: object
          properties:
            operator:
              $ref: "#/components/schemas/RequestsFilterTypeEmpty"
            field:
              description: The field to filter.
              type: string
              enum:
                - gateway_service
          required:
            - operator
            - field
      title: Filter by gateway_service
    MetricsPortalFilterByField:
      oneOf:
        - title: Multiselect filters
          type: object
          properties:
            operator:
              $ref: "#/components/schemas/RequestsFilterType"
            value:
              description: |
                The IDs to include in the results.
              type: array
              items:
                $ref: "#/components/schemas/UnscopedUuid"
            field:
              description: The field to filter.
              type: string
              enum:
                - portal
          required:
            - operator
            - value
            - field
        - title: Empty filters
          type: object
          properties:
            operator:
              $ref: "#/components/schemas/RequestsFilterTypeEmpty"
            field:
              description: The field to filter.
              type: string
              enum:
                - portal
          required:
            - operator
            - field
      title: Filter by portal
    MetricsRealmFilterByField:
      oneOf:
        - title: Multiselect filters
          type: object
          properties:
            operator:
              $ref: "#/components/schemas/RequestsFilterType"
            value:
              description: |
                The IDs to include in the results.
              type: array
              items:
                $ref: "#/components/schemas/UnscopedUuid"
            field:
              description: The field to filter.
              type: string
              enum:
                - realm
          required:
            - operator
            - value
            - field
        - title: Empty filters
          type: object
          properties:
            operator:
              $ref: "#/components/schemas/RequestsFilterTypeEmpty"
            field:
              description: The field to filter.
              type: string
              enum:
                - realm
          required:
            - operator
            - field
      title: Filter by realm
    MetricsResponseSourceFilterByField:
      oneOf:
        - title: Multiselect filters
          type: object
          properties:
            operator:
              $ref: "#/components/schemas/RequestsFilterType"
            value:
              description: |
                The values to include in the results.
              type: array
              items:
                type: string
            field:
              description: The field to filter.
              type: string
              enum:
                - response_source
          required:
            - operator
            - value
            - field
        - title: Empty filters
          type: object
          properties:
            operator:
              $ref: "#/components/schemas/RequestsFilterTypeEmpty"
            field:
              description: The field to filter.
              type: string
              enum:
                - response_source
          required:
            - operator
            - field
      title: Filter by response_source
    MetricsRouteFilterByField:
      oneOf:
        - title: Multiselect filters
          type: object
          properties:
            operator:
              $ref: "#/components/schemas/RequestsFilterType"
            value:
              description: >
                The IDs to include in the results. Because gateway IDs are only
                unique within a given control plane, the filter values must be
                of the form `control_plane_id:field_id` or
                `control_plane_group_id:field_id` for data plane nodes within a
                control plane group.
              type: array
              items:
                $ref: "#/components/schemas/ScopedUuid"
            field:
              description: The field to filter.
              type: string
              enum:
                - route
          required:
            - operator
            - value
            - field
        - title: Empty filters
          type: object
          properties:
            operator:
              $ref: "#/components/schemas/RequestsFilterTypeEmpty"
            field:
              description: The field to filter.
              type: string
              enum:
                - route
          required:
            - operator
            - field
      title: Filter by route
    MetricsStatusCodeFilterByField:
      oneOf:
        - title: Multiselect filters
          type: object
          properties:
            operator:
              $ref: "#/components/schemas/RequestsFilterType"
            value:
              description: |
                The codes to include in the results.
              type: array
              items:
                type: integer
                minimum: 0
                maximum: 999
            field:
              description: The field to filter.
              type: string
              enum:
                - status_code
          required:
            - operator
            - value
            - field
        - title: Empty filters
          type: object
          properties:
            operator:
              $ref: "#/components/schemas/RequestsFilterTypeEmpty"
            field:
              description: The field to filter.
              type: string
              enum:
                - status_code
          required:
            - operator
            - field
      title: Filter by status_code
    MetricsStatusCodeGroupedFilterByField:
      oneOf:
        - title: Multiselect filters
          type: object
          properties:
            operator:
              $ref: "#/components/schemas/RequestsFilterType"
            value:
              description: |
                The code groups to include in the results.
              type: array
              items:
                type: string
                pattern: ^\d[xX][xX]$
            field:
              description: The field to filter.
              type: string
              enum:
                - status_code_grouped
          required:
            - operator
            - value
            - field
        - title: Empty filters
          type: object
          properties:
            operator:
              $ref: "#/components/schemas/RequestsFilterTypeEmpty"
            field:
              description: The field to filter.
              type: string
              enum:
                - status_code_grouped
          required:
            - operator
            - field
      title: Filter by status_code_grouped
    MetricsUpstreamStatusCodeFilterByField:
      oneOf:
        - title: Multiselect filters
          type: object
          properties:
            operator:
              $ref: "#/components/schemas/RequestsFilterType"
            value:
              description: |
                The codes to include in the results.
              type: array
              items:
                type: integer
                minimum: 0
                maximum: 999
            field:
              description: The field to filter.
              type: string
              enum:
                - upstream_status_code
          required:
            - operator
            - value
            - field
        - title: Empty filters
          type: object
          properties:
            operator:
              $ref: "#/components/schemas/RequestsFilterTypeEmpty"
            field:
              description: The field to filter.
              type: string
              enum:
                - upstream_status_code
          required:
            - operator
            - field
      title: Filter by upstream_status_code
    MetricsUpstreamStatusCodeGroupedFilterByField:
      oneOf:
        - title: Multiselect filters
          type: object
          properties:
            operator:
              $ref: "#/components/schemas/RequestsFilterType"
            value:
              description: |
                The code groups to include in the results.
              type: array
              items:
                type: string
                pattern: ^\d[xX][xX]$
            field:
              description: The field to filter.
              type: string
              enum:
                - upstream_status_code_grouped
          required:
            - operator
            - value
            - field
        - title: Empty filters
          type: object
          properties:
            operator:
              $ref: "#/components/schemas/RequestsFilterTypeEmpty"
            field:
              description: The field to filter.
              type: string
              enum:
                - upstream_status_code_grouped
          required:
            - operator
            - field
      title: Filter by upstream_status_code_grouped
    RequestsFilterType:
      description: The type of filter to apply.  `in` filters will limit results to
        only the specified values, while `not_in` filters will exclude the
        specified values.
      type: string
      enum:
        - in
        - not_in
    UnscopedUuid:
      type: string
      pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
    RequestsFilterTypeEmpty:
      description: The type of filter to apply.
      type: string
      enum:
        - empty
        - not_empty
    ScopedUuid:
      type: string
      pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
    AdvancedFilters:
      description: A list of filters to apply to the query.
      type: array
      items:
        discriminator:
          propertyName: field
          mapping:
            api: "#/components/schemas/MetricsApiFilterByField"
            api_package: "#/components/schemas/MetricsApiPackageFilterByField"
            api_product: "#/components/schemas/MetricsApiProductFilterByField"
            api_product_version: "#/components/schemas/MetricsApiProductVersionFilterByField"
            application: "#/components/schemas/MetricsApplicationFilterByField"
            consumer: "#/components/schemas/MetricsConsumerFilterByField"
            control_plane: "#/components/schemas/MetricsControlPlaneFilterByField"
            control_plane_group: "#/components/schemas/MetricsControlPlaneGroupFilterByField"
            country_code: "#/components/schemas/MetricsCountryCodeFilterByField"
            data_plane_node: "#/components/schemas/MetricsDataPlaneNodeFilterByField"
            data_plane_node_version: "#/components/schemas/MetricsDataPlaneNodeVersionFilterByField"
            gateway_service: "#/components/schemas/MetricsGatewayServiceFilterByField"
            portal: "#/components/schemas/MetricsPortalFilterByField"
            realm: "#/components/schemas/MetricsRealmFilterByField"
            response_source: "#/components/schemas/MetricsResponseSourceFilterByField"
            route: "#/components/schemas/MetricsRouteFilterByField"
            status_code: "#/components/schemas/MetricsStatusCodeFilterByField"
            status_code_grouped: "#/components/schemas/MetricsStatusCodeGroupedFilterByField"
            upstream_status_code: "#/components/schemas/MetricsUpstreamStatusCodeFilterByField"
            upstream_status_code_grouped: "#/components/schemas/MetricsUpstreamStatusCodeGr\
              oupedFilterByField"
        oneOf:
          - $ref: "#/components/schemas/MetricsApiFilterByField"
          - $ref: "#/components/schemas/MetricsApiPackageFilterByField"
          - $ref: "#/components/schemas/MetricsApiProductFilterByField"
          - $ref: "#/components/schemas/MetricsApiProductVersionFilterByField"
          - $ref: "#/components/schemas/MetricsApplicationFilterByField"
          - $ref: "#/components/schemas/MetricsConsumerFilterByField"
          - $ref: "#/components/schemas/MetricsControlPlaneFilterByField"
          - $ref: "#/components/schemas/MetricsControlPlaneGroupFilterByField"
          - $ref: "#/components/schemas/MetricsCountryCodeFilterByField"
          - $ref: "#/components/schemas/MetricsDataPlaneNodeFilterByField"
          - $ref: "#/components/schemas/MetricsDataPlaneNodeVersionFilterByField"
          - $ref: "#/components/schemas/MetricsGatewayServiceFilterByField"
          - $ref: "#/components/schemas/MetricsPortalFilterByField"
          - $ref: "#/components/schemas/MetricsRealmFilterByField"
          - $ref: "#/components/schemas/MetricsResponseSourceFilterByField"
          - $ref: "#/components/schemas/MetricsRouteFilterByField"
          - $ref: "#/components/schemas/MetricsStatusCodeFilterByField"
          - $ref: "#/components/schemas/MetricsStatusCodeGroupedFilterByField"
          - $ref: "#/components/schemas/MetricsUpstreamStatusCodeFilterByField"
          - $ref: "#/components/schemas/MetricsUpstreamStatusCodeGroupedFilterByField"
```
