---
title: "ExploreV2Dto"
url: "https://nov18-dev.movespot.fyi/apis/konnect-explore-endpoint-dev-4/versions/0f8ac6c3-1f91-4060-82fe-5fd3fe57d9ec/schemas/ExploreV2Dto"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/konnect-explore-endpoint-dev-4/versions/0f8ac6c3-1f91-4060-82fe-5fd3fe57d9ec.md

# ExploreV2Dto

A query to launch at the API

## OpenAPI definition

```yaml
openapi: 3.0.2
info:
  title: Konnect Explore Endpoint
  version: 4.0.0
servers:
  - url: https://us.api.konghq.com/v4
    description: United-States Production region
  - url: https://eu.api.konghq.com/v4
    description: Europe Production region
  - url: https://au.api.konghq.com/v4
    description: Australia Production region
  - url: https://me.api.konghq.com/v4
    description: Middle-East Production region
  - url: https://in.api.konghq.com/v4
    description: India Production region
  - url: https://sg.api.konghq.com/v4
    description: Singapore Production region
components:
  schemas:
    ExploreFilter:
      description: A filter that specifies which data to include in the query
      type: object
      properties:
        dimension:
          type: string
          example: status_code
          enum:
            - api_product
            - api_product_version
            - application
            - consumer
            - control_plane
            - control_plane_group
            - data_plane_node
            - gateway_service
            - route
            - status_code
            - status_code_grouped
        type:
          type: string
          example: in
          enum:
            - in
            - not_in
            - selector
        values:
          type: array
          items:
            type: string
      required:
        - dimension
        - type
        - values
    RelativeTimeRangeDtoV2:
      description: A duration representing a relative-to-now span of time. Generally
        the start time is floored to the requested granularity. Eg 7d from now,
        with 1day granularity initiated at 2024-01-08T17:11:00+05:00 will query
        for the time range from 2024-01-01T00:00:00+05:00 to
        2024-01-08T17:11:00+05:00. The exact start and end timestamps are
        returned in the result query in the meta.start_ms and meta.end_ms
        fields. If the granularity for the previous query was 1hour, it would
        query a time range from 2024-01-01T17:00:00+05:00 to
        2024-01-08T17:11:00+05:00.
      type: object
      properties:
        tz:
          type: string
          default: Etc/UTC
        type:
          type: string
          enum:
            - relative
        time_range:
          type: string
          default: 1h
          enum:
            - 15m
            - 1h
            - 6h
            - 12h
            - 24h
            - 7d
            - 30d
            - current_week
            - current_month
            - previous_week
            - previous_month
      required:
        - type
        - time_range
    AbsoluteTimeRangeDtoV2:
      description: A duration representing an exact start and end time.
      type: object
      properties:
        tz:
          type: string
          default: Etc/UTC
        type:
          type: string
          enum:
            - absolute
        start:
          type: string
          format: date-time
        end:
          type: string
          format: date-time
      required:
        - type
    ExploreV2Dto:
      description: A query to launch at the API
      type: object
      properties:
        metrics:
          description: List of aggregated metrics to collect across the requested time span.
          type: array
          items:
            type: string
            enum:
              - request_count
              - request_per_minute
              - response_latency_p99
              - response_latency_p95
              - response_latency_p50
              - response_latency_average
              - upstream_latency_p99
              - upstream_latency_p95
              - upstream_latency_p50
              - upstream_latency_average
              - kong_latency_p99
              - kong_latency_p95
              - kong_latency_p50
              - kong_latency_average
              - response_size_p99
              - response_size_p95
              - response_size_p50
              - request_size_p99
              - request_size_p95
              - request_size_p50
              - request_size_average
              - response_size_average
          example:
            - request_count
        dimensions:
          description: List of attributes or entity types to group by.
          type: array
          items:
            type: string
            enum:
              - api_product
              - api_product_version
              - application
              - consumer
              - control_plane
              - control_plane_group
              - data_plane_node
              - gateway_service
              - route
              - status_code
              - status_code_grouped
              - time
          example:
            - status_code_grouped
          maxItems: 2
          minItems: 0
        filters:
          description: A list of filters to apply to the query.
          type: array
          items:
            $ref: "#/components/schemas/ExploreFilter"
        granularity:
          description: >
            Force time grouping into buckets of the specified duration.  Only
            has an effect if "time" is in the "dimensions" list.


            If "trend" is chosen, the time range covered by the query will be
            twice the specified time range, and the granularity will be set such
            that two time buckets are returned, one for the given time range and
            one for the same time range prior.

            For example:


            time range: last 24 hours

            granularity: trend


            will return 2 time buckets (assuming both have data):


            - 48 hours ago to 24 hours ago

            - 24 hours ago to now


            Another example:


            time range: 2020-05-01 to 2020-05-15

            granularity: trend


            will return 2 time buckets:


            - 2020-04-15 through 2020-04-30

            - 2020-05-01 through 2020-05-15


            The granularity of the result may be coarser than requested.  The
            finest allowed granularity depends on the query's time range: data
            farther in the past may have coarser granularity.  The exact result
            granularity will be reported in the response `meta.granularity_ms`
            field.


            If granularity is not specified and "time" is in the dimensions
            list, a default will be chosen based on the time range requested.
          type: string
          enum:
            - minute
            - hour
            - day
            - week
            - trend
        time_range:
          description: The time range to query.
          default:
            type: relative
            time_range: 1h
          discriminator:
            propertyName: type
            mapping:
              relative: "#/components/schemas/RelativeTimeRangeDtoV2"
              absolute: "#/components/schemas/AbsoluteTimeRangeDtoV2"
          oneOf:
            - $ref: "#/components/schemas/RelativeTimeRangeDtoV2"
            - $ref: "#/components/schemas/AbsoluteTimeRangeDtoV2"
        meta:
          type: object
      example:
        time_range:
          type: relative
          time_range: 24h
          tz: EST
        dimensions:
          - time
          - gateway_service
        filters:
          - type: in
            dimension: control_plane
            values:
              - d5ac5d88-efed-4e10-9dfe-0b0a6646c219
        granularity: hour
        metrics:
          - response_latency_p99
          - response_latency_p95
          - response_latency_p50
      required:
        - metrics
```
