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

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

# VulnerabilitiesMetricsResponseMetadata

Metadata about the query response. This includes: - The start and end times of the query - The granularity of the result - Whether the result was truncated - The limit of the result - The `query_id`

## 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:
    MetricDimensionDisplayEntry:
      type: object
      required:
        - id
        - name
      properties:
        id:
          type: string
        name:
          type: string
        deleted:
          type: boolean
        is_other_group:
          type: boolean
    VulnerabilitiesMetricsResponseMetadata:
      type: object
      description: |
        Metadata about the query response. This includes:
          - The start and end times of the query
          - The granularity of the result
          - Whether the result was truncated
          - The limit of the result
          - The `query_id`
      required:
        - start
        - start_ms
        - end
        - end_ms
        - display
        - metric_names
        - metric_units
        - granularity_ms
        - truncated
        - limit
        - query_id
      properties:
        start:
          type: string
          format: date-time
          description: Start of the query time range in RFC-3339 format.
          example: 2025-03-30T07:20:50Z
        start_ms:
          type: number
          description: Start of the query time range in epoch format with millisecond
            precision.
          example: 1743319250000
        end:
          type: string
          format: date-time
          description: End of the query time range in RFC-3339 format.
          example: 2025-03-30T08:20:50Z
        end_ms:
          type: number
          description: End of the query time range in epoch format with millisecond
            precision.
          example: 1743322850000
        metric_names:
          type: array
          description: List of vulnerability metric names included in the result.
          items:
            type: string
            enum:
              - vulnerability_count
        metric_units:
          type: object
          description: >
            A mapping of metric names to their associated human-friendly display
            unit.

            The keys are the metric names, and the values are the units.
          properties:
            vulnerability_count:
              type: string
              enum:
                - count
        granularity_ms:
          type: number
          description: |
            The number of milliseconds per interval in a time series.
        truncated:
          type: boolean
          description: >
            Set to `true`` when the limit of cardinarlity is hit.

            For queries with 2 dimensions, the limit truncates the first
            dimension, and then groups all other groupings for the second
            dimension.


            Example: limit of 2 for `service` and `region` would return 2
            services maximum, and 2 regions + ____OTHER____.

            The ____OTHER___ is representative of all other regions.
        limit:
          type: number
          description: The applied cardinality limit.
        query_id:
          type: string
          description: An ID that can be used to reference the query.
          example: e2a6c0ce-3a90-4b6b-b9bf-cf6428d30ffe
        display:
          type: object
          description: >
            Instructs how to interpret identifiers in the query result.

            The structure consists of: dimension -> ID -> entity metadata.

            Since entity names within Konnect may overlap, ids are returned and
            used for exact grouping.

            This blob may be used to join and display results in a more
            human-friendly manner.

            Since IDs represent entities in the system at all points in time,
            historical data will still exist even if an entity is deleted.

            These such entities are marked with the `deleted: true` value.

            Another special case is the `____OTHER____` entity.

            When the limit of cardinality is reached for a second dimension, the
            system will group all other entities into the ____OTHER____
            grouping.

            This prevents returning an overwhelming number of long tail
            entities.
          properties:
            service:
              type: object
              additionalProperties:
                $ref: "#/components/schemas/MetricDimensionDisplayEntry"
            severity:
              type: object
              additionalProperties:
                $ref: "#/components/schemas/MetricDimensionDisplayEntry"
            state:
              type: object
              additionalProperties:
                $ref: "#/components/schemas/MetricDimensionDisplayEntry"
            type:
              type: object
              additionalProperties:
                $ref: "#/components/schemas/MetricDimensionDisplayEntry"
            source:
              type: object
              additionalProperties:
                $ref: "#/components/schemas/MetricDimensionDisplayEntry"
            environment:
              type: object
              additionalProperties:
                $ref: "#/components/schemas/MetricDimensionDisplayEntry"
            region:
              type: object
              additionalProperties:
                $ref: "#/components/schemas/MetricDimensionDisplayEntry"
          example:
            service:
              3a564a6a-1952-4181-89f0-a1cadc70123d:
                id: 3a564a6a-1952-4181-89f0-a1cadc70123d
                name: Pricing Svc
                deleted: false
              58620e4e-27f4-42eb-9776-402ec319c665:
                id: 58620e4e-27f4-42eb-9776-402ec319c665
                name: Billing Svc
                deleted: true
            state:
              open:
                id: open
                name: Open
                deleted: false
              fixed:
                id: fixed
                name: Fixed
                deleted: false
              dismissed:
                id: dismissed
                name: Dismissed
                deleted: false
```