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

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

# MetricsResponseMeta

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, and the query_id.

## 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:
    MetricsDisplayBlob:
      description: >
        The blob represents how to interpret large UUID strings in the
        MetricsResult. The structure is records of dimension_id ->  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` key.


        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.
      type: object
      properties:
        api:
          type: object
          additionalProperties:
            $ref: "#/components/schemas/DisplayEntry"
        api_package:
          type: object
          additionalProperties:
            $ref: "#/components/schemas/DisplayEntry"
        api_product:
          type: object
          additionalProperties:
            $ref: "#/components/schemas/DisplayEntry"
        api_product_version:
          type: object
          additionalProperties:
            $ref: "#/components/schemas/DisplayEntry"
        application:
          type: object
          additionalProperties:
            $ref: "#/components/schemas/DisplayEntry"
        consumer:
          type: object
          additionalProperties:
            $ref: "#/components/schemas/DisplayEntry"
        control_plane:
          type: object
          additionalProperties:
            $ref: "#/components/schemas/DisplayEntry"
        control_plane_group:
          type: object
          additionalProperties:
            $ref: "#/components/schemas/DisplayEntry"
        country_code:
          type: object
          additionalProperties:
            $ref: "#/components/schemas/DisplayEntry"
        data_plane_node:
          type: object
          additionalProperties:
            $ref: "#/components/schemas/DisplayEntry"
        data_plane_node_version:
          type: object
          additionalProperties:
            $ref: "#/components/schemas/DisplayEntry"
        gateway_service:
          type: object
          additionalProperties:
            $ref: "#/components/schemas/DisplayEntry"
        portal:
          type: object
          additionalProperties:
            $ref: "#/components/schemas/DisplayEntry"
        response_source:
          type: object
          additionalProperties:
            $ref: "#/components/schemas/DisplayEntry"
        route:
          type: object
          additionalProperties:
            $ref: "#/components/schemas/DisplayEntry"
        status_code:
          type: object
          additionalProperties:
            $ref: "#/components/schemas/DisplayEntry"
        status_code_grouped:
          type: object
          additionalProperties:
            $ref: "#/components/schemas/DisplayEntry"
        upstream_status_code:
          type: object
          additionalProperties:
            $ref: "#/components/schemas/DisplayEntry"
        upstream_status_code_grouped:
          type: object
          additionalProperties:
            $ref: "#/components/schemas/DisplayEntry"
      example:
        gateway_service:
          d5ac5d88-efed-4e10-9dfe-0b0a6646c219:bf16907c-8673-4f9d-aa83-111111111111:
            id: d5ac5d88-efed-4e10-9dfe-0b0a6646c219:bf16907c-8673-4f9d-aa83-111111111111
            deleted: true
            name: Gateway Service Alpha
          d5ac5d88-efed-4e10-9dfe-0b0a6646c219:bf16907c-8673-4f9d-aa83-1f2ea9215055:
            id: d5ac5d88-efed-4e10-9dfe-0b0a6646c219:bf16907c-8673-4f9d-aa83-1f2ea9215055
            deleted: false
            name: Gateway Service Beta
    MetricUnits:
      description: >
        A mapping of metric names to their associated unit. The keys are the
        metric names, and the values are the units. The possible units are: `ms`
        (Millisecond), `count`, and `bytes`
      type: object
      properties: {}
      example:
        request_count: count
        response_latency_p99: ms
    DisplayEntry:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        deleted:
          type: boolean
        is_other_group:
          type: boolean
      example:
        id: d5ac5d88-efed-4e10-9dfe-0b0a6646c219:bf16907c-8673-4f9d-aa83-111111111111
        deleted: true
        name: Gateway Service Alpha
      required:
        - id
        - name
    MetricsResponseMeta:
      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, and the query_id.
      type: object
      properties:
        start:
          description: |
            Start of the query time range.
          type: string
          format: date-time
          readOnly: true
        end:
          description: |
            End of the query time range.
          type: string
          format: date-time
          readOnly: true
        display:
          description: >
            The blob represents how to interpret large UUID strings in the
            MetricsResult. The structure is records of dimension_id ->  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` key.


            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.
          allOf:
            - $ref: "#/components/schemas/MetricsDisplayBlob"
          readOnly: true
        metric_units:
          description: >
            A meta object that describes how to interpret metric names and their
            associated unit.
          allOf:
            - $ref: "#/components/schemas/MetricUnits"
          readOnly: true
        granularity_ms:
          description: |
            The number of milliseconds per interval in a time series.
          type: number
          readOnly: true
        truncated:
          description: >
            Set 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 gateway_service and status_code would return
            2 gateway services maximum, and 2 status codes + ____OTHER____. The
            ____OTHER___ is representing all other status codes.
          type: boolean
          readOnly: true
        limit:
          description: |
            Applied query cardinality limit.
          type: number
          readOnly: true
        query_id:
          description: |
            An ID that can be used to reference the query.
          type: string
          readOnly: true
      example:
        start: 2024-01-16T18:00:00.000Z
        end: 2024-01-16T18:16:40.000Z
        display:
          gateway_service:
            d5ac5d88-efed-4e10-9dfe-0b0a6646c219:bf16907c-8673-4f9d-aa83-111111111111:
              id: d5ac5d88-efed-4e10-9dfe-0b0a6646c219:bf16907c-8673-4f9d-aa83-111111111111
              deleted: true
              name: Gateway Service Alpha
            d5ac5d88-efed-4e10-9dfe-0b0a6646c219:bf16907c-8673-4f9d-aa83-1f2ea9215055:
              id: d5ac5d88-efed-4e10-9dfe-0b0a6646c219:bf16907c-8673-4f9d-aa83-1f2ea9215055
              deleted: false
              name: Gateway Service Beta
        metric_units:
          request_count: count
          response_latency_p99: ms
        granularity_ms: 60000
        truncated: false
        limit: 50
        query_id: requested-query-id
      required:
        - start
        - end
        - display
        - metric_units
        - granularity_ms
        - truncated
        - limit
        - query_id
```
