---
title: "Filter by route"
url: "https://nov18-dev.movespot.fyi/apis/konnect-api-request-analytics-2/versions/df5e182e-3b27-4baf-b6d7-0b0a459c9f64/schemas/RouteFilterByField"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/konnect-api-request-analytics-2/versions/df5e182e-3b27-4baf-b6d7-0b0a459c9f64.md

# Filter by route

## OpenAPI definition

```yaml
openapi: 3.0.2
info:
  title: Konnect API Request Analytics
  version: 2.0.0
servers:
  - url: https://us.api.konghq.com/v2
    description: United-States Production region
  - url: https://eu.api.konghq.com/v2
    description: Europe Production region
  - url: https://au.api.konghq.com/v2
    description: Australia Production region
  - url: https://me.api.konghq.com/v2
    description: Middle-East Production region
  - url: https://in.api.konghq.com/v2
    description: India Production region
  - url: https://sg.api.konghq.com/v2
    description: Singapore Production region
components:
  schemas:
    FilterMultiValueScopedUUID:
      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"
      required:
        - operator
        - value
      title: Multiselect filters
    FilterSingleValueScopedUUID:
      type: object
      properties:
        operator:
          $ref: "#/components/schemas/RequestsFilterTypeEquals"
        value:
          description: >
            The ID 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: 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}$
      required:
        - operator
        - value
      title: Single select filters
    FilterEmpty:
      type: object
      properties:
        operator:
          $ref: "#/components/schemas/RequestsFilterTypeEmpty"
      required:
        - operator
      title: Empty filters
    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
    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}$
    RequestsFilterTypeEquals:
      description: The type of filter to apply.
      type: string
      enum:
        - =
        - "!="
    RequestsFilterTypeEmpty:
      description: The type of filter to apply.
      type: string
      enum:
        - empty
        - not_empty
    RouteFilterByField:
      allOf:
        - type: object
          properties:
            field:
              description: The field to filter.
              type: string
              enum:
                - route
          required:
            - field
        - oneOf:
            - $ref: "#/components/schemas/FilterMultiValueScopedUUID"
            - $ref: "#/components/schemas/FilterSingleValueScopedUUID"
            - $ref: "#/components/schemas/FilterEmpty"
      title: Filter by route
```
