---
title: "QueryResponseMeta"
url: "https://nov18-dev.movespot.fyi/apis/portal-application-analytics-2/versions/7eb4e759-6c13-4850-865d-25ae682ee61a/schemas/QueryResponseMeta"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/portal-application-analytics-2/versions/7eb4e759-6c13-4850-865d-25ae682ee61a.md

# QueryResponseMeta

Query response metadata.

## OpenAPI definition

```yaml
openapi: 3.0.0
info:
  title: Portal Application Analytics
  version: 3.0.1
components:
  schemas:
    DisplayBlob:
      type: object
      properties:
        api:
          type: object
          additionalProperties:
            $ref: "#/components/schemas/DisplayEntry"
        application:
          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"
      example:
        applciation:
          bf16907c-8673-4f9d-aa83-111111111111:
            deleted: true
            name: bf16907c-8673-4f9d-aa83-111111111111
          bf16907c-8673-4f9d-aa83-1f2ea9215055:
            deleted: false
            name: Api v1 Beta
    DisplayEntry:
      type: object
      properties:
        name:
          type: string
        deleted:
          type: boolean
        is_other_group:
          type: boolean
      example:
        deleted: true
        name: Api Alpha v1
      required:
        - name
    QueryResponseMeta:
      description: Query response metadata.
      type: object
      properties:
        display:
          description: >
            The blob represents how to interpret large UUID strings in the
            `data` response. 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/DisplayBlob"
        metric_names:
          description: The metric requested in query.
          type: array
          items:
            type: string
            enum:
              - request_count
              - request_per_minute
              - response_latency_average
              - response_size_average
              - response_size_sum
              - request_size_average
              - request_size_sum
          maxItems: 1
          minItems: 1
        metric_units:
          description: The unit of metric.
          type: object
          properties:
            request_count:
              type: string
              default: count
            request_per_minute:
              type: string
              default: count/minute
            response_latency_average:
              type: string
              default: ms
            response_size_average:
              type: string
              default: bytes
            response_size_sum:
              type: string
              default: bytes
            request_size_average:
              type: string
              default: bytes
            request_size_sum:
              type: string
              default: bytes
        start:
          description: |
            Start of the query time range.
          type: string
          format: date-time
        end:
          description: |
            End of the query time range.
          type: string
          format: date-time
        truncated:
          description: True if the limit of dimension values was reached and results were
            truncated. Limit value is 50.
          type: boolean
        limit:
          description: |
            Applied query cardinality limit.
          type: number
        granularity_ms:
          description: The resulting time bucket for the returned data. If `time` was not
            specified as a dimension, granularity is the duration of the query.
          type: integer
        query_id:
          description: Optional ID used to look up the query.
          type: string
      additionalProperties: false
```
