---
title: "VulnerabilitiesMetricsFilterByScanAttributes"
url: "https://us-prod.jeffyongtaotang.com/apis/konnect-service-catalog-1/versions/cdbef9b7-686c-4189-bbc8-55c727a972e8/schemas/VulnerabilitiesMetricsFilterByScanAttributes"
---

> Full API specification: https://us-prod.jeffyongtaotang.com/apis/konnect-service-catalog-1/versions/cdbef9b7-686c-4189-bbc8-55c727a972e8.md

# VulnerabilitiesMetricsFilterByScanAttributes

Filters a metrics query by `scan_attributes` properties. Dot-notation off of `scan_attributes` is used to specify the property to filter by. Example: `scan_attributes.image_tag`.

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Konnect Service Catalog
  version: 1.3.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:
    EmptyValueMetricsFilter:
      type: object
      required:
        - operator
      properties:
        operator:
          $ref: "#/components/schemas/MetricsFilterEmptyOperator"
    StringValueMetricsFilter:
      type: object
      required:
        - operator
        - value
      properties:
        operator:
          $ref: "#/components/schemas/MetricsFilterInOperator"
        value:
          type: array
          items:
            type: string
    NumericValueMetricsFilter:
      type: object
      required:
        - operator
        - value
      properties:
        operator:
          $ref: "#/components/schemas/MetricsFilterNumericOperator"
        value:
          type: number
    MetricsFilterEmptyOperator:
      type: string
      description: |
        The type of filter to apply.
        Empty values are `null` or undefined.
      enum:
        - empty
        - not_empty
    MetricsFilterInOperator:
      type: string
      description: |
        The type of filter to apply.
          - `in` filters will limit results to only the specified values
          - `not_in` filters will exclude the specified values
      enum:
        - in
        - not_in
    MetricsFilterNumericOperator:
      type: string
      description: The type of filter to apply to numeric field values.
      enum:
        - =
        - "!="
        - <
        - ">"
        - <=
        - ">="
    VulnerabilitiesMetricsFilterByScanAttributes:
      description: >
        Filters a metrics query by `scan_attributes` properties.

        Dot-notation off of `scan_attributes` is used to specify the property to
        filter by.


        Example: `scan_attributes.image_tag`.
      allOf:
        - type: object
          required:
            - field
          properties:
            field:
              type: string
              pattern: ^scan_attributes\.[^.\s]+$
        - oneOf:
            - $ref: "#/components/schemas/EmptyValueMetricsFilter"
            - $ref: "#/components/schemas/StringValueMetricsFilter"
            - $ref: "#/components/schemas/NumericValueMetricsFilter"
      example:
        field: scan_attributes.image_version
        operator: in
        value:
          - 2.0.7
```