---
title: "FilterTimeRange"
url: "https://nov18-dev.movespot.fyi/apis/konnect-api-request-analytics-2/versions/df5e182e-3b27-4baf-b6d7-0b0a459c9f64/schemas/FilterTimeRange"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/konnect-api-request-analytics-2/versions/df5e182e-3b27-4baf-b6d7-0b0a459c9f64.md

# FilterTimeRange

The period of time to return data. Relative time ranges are relative to the current moment. Absolute time ranges specify an unchanging period of time. If not specified, a default relative timeframe of 1 hour will be chosen.

## OpenAPI definition

```yaml
openapi: 3.0.2
info:
  title: Konnect API Request Analytics
  version: 2.0.0
servers:
  - url: https://us.api.konghq.com/v2
    description: United-States Production region
  - url: https://eu.api.konghq.com/v2
    description: Europe Production region
  - url: https://au.api.konghq.com/v2
    description: Australia Production region
  - url: https://me.api.konghq.com/v2
    description: Middle-East Production region
  - url: https://in.api.konghq.com/v2
    description: India Production region
  - url: https://sg.api.konghq.com/v2
    description: Singapore Production region
components:
  schemas:
    RequestsRelativeTimeRange:
      type: object
      properties:
        tz:
          description: >
            The time zone of the requestor, provided as a string matching the

            tz database.  This helps determine day boundaries for relative time

            ranges spanning more than 24 hours: for example, submitting a
            request

            for data from the last 7 days on `2020-01-08T00:00:00` in timezone

            US/Eastern will find results starting from `2020-01-01T05:00:00Z`
            (UTC).
          type: string
          example: US/Eastern
          default: Etc/UTC
        type:
          description: |
            Request data from a time relative to the current time.
          type: string
          enum:
            - relative
        time_range:
          description: >
            Return results from the last fifteen minutes, one hour, six hours,
            etc.
          type: string
          default: 12H
          enum:
            - 15M
            - 1H
            - 6H
            - 12H
            - 24H
            - 7D
      additionalProperties: false
      required:
        - type
        - time_range
    RequestsAbsoluteTimeRange:
      type: object
      properties:
        tz:
          description: |
            The time zone of the requestor.  This is used to localize the start
            and end times, if desired: for example, requesting a start time of
            `2020-01-01T00:00:00` in timezone US/Eastern will find results
            starting from `2020-01-01T05:00:00Z` (UTC).
          type: string
          example: US/Eastern
          default: Etc/UTC
        type:
          description: >
            Request data from a specific time range.  Note that the requested

            times must be within the data retention period for your
            organization.
          type: string
          enum:
            - absolute
        start:
          description: The start time in the given timezone.
          type: string
          format: date-time
          example: 2020-01-01T00:00:00
        end:
          description: The end time in the given timezone.
          type: string
          format: date-time
          example: 2020-01-01T00:00:00
      additionalProperties: false
      required:
        - type
        - start
        - end
    FilterTimeRange:
      description: The period of time to return data. Relative time ranges are
        relative to the current moment. Absolute time ranges specify an
        unchanging period of time. If not specified, a default relative
        timeframe of 1 hour will be chosen.
      default:
        type: relative
        time_range: 1H
      discriminator:
        propertyName: type
        mapping:
          relative: "#/components/schemas/RequestsRelativeTimeRange"
          absolute: "#/components/schemas/RequestsAbsoluteTimeRange"
      oneOf:
        - $ref: "#/components/schemas/RequestsRelativeTimeRange"
        - $ref: "#/components/schemas/RequestsAbsoluteTimeRange"
```
