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

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

# Filter by dimension

## 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:
    ApiProductFilterByDimension:
      type: object
      properties:
        dimension:
          description: The dimension to filter.  This will be deprecated in favor of
            `field`.
          type: string
          enum:
            - api_product
        type:
          $ref: "#/components/schemas/RequestsFilterType"
        values:
          description: |
            The IDs to include in the results.
          type: array
          items:
            $ref: "#/components/schemas/UnscopedUuid"
      additionalProperties: false
      required:
        - dimension
        - type
        - values
      title: Filter by api_product
    ApiProductVersionFilterByDimension:
      type: object
      properties:
        dimension:
          description: The dimension to filter.  This will be deprecated in favor of
            `field`.
          type: string
          enum:
            - api_product_version
        type:
          $ref: "#/components/schemas/RequestsFilterType"
        values:
          description: |
            The IDs to include in the results.
          type: array
          items:
            $ref: "#/components/schemas/UnscopedUuid"
      required:
        - dimension
        - type
        - values
      title: Filter by api_product_version
    ApplicationFilterByDimension:
      type: object
      properties:
        dimension:
          description: The dimension to filter.  This will be deprecated in favor of
            `field`.
          type: string
          enum:
            - application
        type:
          $ref: "#/components/schemas/RequestsFilterType"
        values:
          description: |
            The IDs to include in the results.
          type: array
          items:
            $ref: "#/components/schemas/UnscopedUuid"
      required:
        - dimension
        - type
        - values
      title: Filter by application
    ConsumerFilterByDimension:
      type: object
      properties:
        dimension:
          description: The dimension to filter.  This will be deprecated in favor of
            `field`.
          type: string
          enum:
            - consumer
        type:
          $ref: "#/components/schemas/RequestsFilterType"
        values:
          description: |
            The IDs to include in the results.
          type: array
          items:
            $ref: "#/components/schemas/ScopedUuid"
      required:
        - dimension
        - type
        - values
      title: Filter by consumer
    ControlPlaneFilterByDimension:
      type: object
      properties:
        dimension:
          description: The dimension to filter.  This will be deprecated in favor of
            `field`.
          type: string
          enum:
            - control_plane
        type:
          $ref: "#/components/schemas/RequestsFilterType"
        values:
          description: |
            The IDs to include in the results.
          type: array
          items:
            $ref: "#/components/schemas/UnscopedUuid"
      required:
        - dimension
        - type
        - values
      title: Filter by control_plane
    ControlPlaneGroupFilterByDimension:
      type: object
      properties:
        dimension:
          description: The dimension to filter.  This will be deprecated in favor of
            `field`.
          type: string
          enum:
            - control_plane_group
        type:
          $ref: "#/components/schemas/RequestsFilterType"
        values:
          description: |
            The IDs to include in the results.
          type: array
          items:
            $ref: "#/components/schemas/UnscopedUuid"
      required:
        - dimension
        - type
        - values
      title: Filter by control_plane_group
    DataPlaneNodeFilterByDimension:
      type: object
      properties:
        dimension:
          description: The dimension to filter.  This will be deprecated in favor of
            `field`.
          type: string
          enum:
            - data_plane_node
        type:
          $ref: "#/components/schemas/RequestsFilterType"
        values:
          description: |
            The IDs to include in the results.
          type: array
          items:
            $ref: "#/components/schemas/ScopedUuid"
      required:
        - dimension
        - type
        - values
      title: Filter by data_plane_node
    GatewayServiceFilterByDimension:
      type: object
      properties:
        dimension:
          description: The dimension to filter.  This will be deprecated in favor of
            `field`.
          type: string
          enum:
            - gateway_service
        type:
          $ref: "#/components/schemas/RequestsFilterType"
        values:
          description: |
            The IDs to include in the results.
          type: array
          items:
            $ref: "#/components/schemas/ScopedUuid"
      required:
        - dimension
        - type
        - values
      title: Filter by gateway_service
    RouteFilterByDimension:
      type: object
      properties:
        dimension:
          description: The dimension to filter.  This will be deprecated in favor of
            `field`.
          type: string
          enum:
            - route
        type:
          $ref: "#/components/schemas/RequestsFilterType"
        values:
          description: |
            The IDs to include in the results.
          type: array
          items:
            $ref: "#/components/schemas/ScopedUuid"
      required:
        - dimension
        - type
        - values
      title: Filter by route
    StatusCodeFilterByDimension:
      type: object
      properties:
        dimension:
          description: The dimension to filter.  This will be deprecated in favor of
            `field`.
          type: string
          enum:
            - status_code
        type:
          $ref: "#/components/schemas/RequestsFilterType"
        values:
          description: |
            The codes to include in the results.
          type: array
          items:
            type: integer
            minimum: 0
            maximum: 999
      required:
        - dimension
        - type
        - values
      title: Filter by status_code
    StatusCodeGroupedFilterByDimension:
      type: object
      properties:
        dimension:
          description: The dimension to filter.  This will be deprecated in favor of
            `field`.
          type: string
          enum:
            - status_code_grouped
        type:
          $ref: "#/components/schemas/RequestsFilterType"
        values:
          description: |
            The codes to include in the results.
          type: array
          items:
            type: string
            pattern: ^\d[xX][xX]$
      required:
        - dimension
        - type
        - values
      title: Filter by status_code_grouped
    FilterTimeRange:
      description: The period of time to return data. Relative time ranges are
        relative to the current moment. Absolute time ranges specify an
        unchanging period of time. If not specified, a default relative
        timeframe of 1 hour will be chosen.
      default:
        type: relative
        time_range: 1H
      discriminator:
        propertyName: type
        mapping:
          relative: "#/components/schemas/RequestsRelativeTimeRange"
          absolute: "#/components/schemas/RequestsAbsoluteTimeRange"
      oneOf:
        - $ref: "#/components/schemas/RequestsRelativeTimeRange"
        - $ref: "#/components/schemas/RequestsAbsoluteTimeRange"
    FilterOrder:
      description: Order of results sorted by time.
      type: string
      default: descending
      enum:
        - ascending
        - descending
    FilterSize:
      description: Number of requests to be returned.
      type: integer
      default: 100
      maximum: 1000
    FilterOffset:
      description: Number of requests to be skipped when returning results.
      type: integer
      default: 0
    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}$
    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}$
    RequestsRelativeTimeRange:
      type: object
      properties:
        tz:
          description: >
            The time zone of the requestor, provided as a string matching the

            tz database.  This helps determine day boundaries for relative time

            ranges spanning more than 24 hours: for example, submitting a
            request

            for data from the last 7 days on `2020-01-08T00:00:00` in timezone

            US/Eastern will find results starting from `2020-01-01T05:00:00Z`
            (UTC).
          type: string
          example: US/Eastern
          default: Etc/UTC
        type:
          description: |
            Request data from a time relative to the current time.
          type: string
          enum:
            - relative
        time_range:
          description: >
            Return results from the last fifteen minutes, one hour, six hours,
            etc.
          type: string
          default: 12H
          enum:
            - 15M
            - 1H
            - 6H
            - 12H
            - 24H
            - 7D
      additionalProperties: false
      required:
        - type
        - time_range
    RequestsAbsoluteTimeRange:
      type: object
      properties:
        tz:
          description: |
            The time zone of the requestor.  This is used to localize the start
            and end times, if desired: for example, requesting a start time of
            `2020-01-01T00:00:00` in timezone US/Eastern will find results
            starting from `2020-01-01T05:00:00Z` (UTC).
          type: string
          example: US/Eastern
          default: Etc/UTC
        type:
          description: >
            Request data from a specific time range.  Note that the requested

            times must be within the data retention period for your
            organization.
          type: string
          enum:
            - absolute
        start:
          description: The start time in the given timezone.
          type: string
          format: date-time
          example: 2020-01-01T00:00:00
        end:
          description: The end time in the given timezone.
          type: string
          format: date-time
          example: 2020-01-01T00:00:00
      additionalProperties: false
      required:
        - type
        - start
        - end
    AnalyticsRequestsFilterByDimensionQuery:
      type: object
      properties:
        filters:
          type: array
          items:
            oneOf:
              - $ref: "#/components/schemas/ApiProductFilterByDimension"
              - $ref: "#/components/schemas/ApiProductVersionFilterByDimension"
              - $ref: "#/components/schemas/ApplicationFilterByDimension"
              - $ref: "#/components/schemas/ConsumerFilterByDimension"
              - $ref: "#/components/schemas/ControlPlaneFilterByDimension"
              - $ref: "#/components/schemas/ControlPlaneGroupFilterByDimension"
              - $ref: "#/components/schemas/DataPlaneNodeFilterByDimension"
              - $ref: "#/components/schemas/GatewayServiceFilterByDimension"
              - $ref: "#/components/schemas/RouteFilterByDimension"
              - $ref: "#/components/schemas/StatusCodeFilterByDimension"
              - $ref: "#/components/schemas/StatusCodeGroupedFilterByDimension"
          default: []
        time_range:
          $ref: "#/components/schemas/FilterTimeRange"
        order:
          $ref: "#/components/schemas/FilterOrder"
        size:
          $ref: "#/components/schemas/FilterSize"
        offset:
          $ref: "#/components/schemas/FilterOffset"
      additionalProperties: false
      deprecated: true
      title: Filter by dimension
```
