Skip to main content

TimeRangeInput

The fields required to specify the time range for a time series, counter, or leaderboard Metric query.

If no relative or absolute time ranges are provided, Propel defaults to an absolute time range beginning with the earliest record in the Metric's Data Pool and ending with the latest record.

If both relative and absolute time ranges are provided, the relative time range will take precedence.

If a LAST_N relative time period is selected, an n ≥ 1 must be provided. If no n is provided or n < 1, a BAD_REQUEST error will be returned.

fields

  • relative optional RelativeTimeRange

    The relative time period.

    The Relative time ranges are based on the current date and time.

    THIS - The current unit of time. For example, if today is June 8, 2022, and THIS_MONTH is selected, then data for June 2022 would be returned.

    PREVIOUS - The previous unit of time. For example, if today is June 8, 2022, and PREVIOUS_MONTH is selected, then data for May 2022 would be returned. It excludes the current unit of time.

    NEXT - The next unit of time. For example, if today is June 8, 2022, and NEXT_MONTH is selected, then data for July 2022 would be returned. It excludes the current unit of time.

    LAST_N - The last n units of time, including the current one. For example, if today is June 8, 2022 and LAST_N_YEARS with n = 3 is selected, then data for 2020, 2021, and 2022 will be returned. It will include the current time period.

    • THIS_HOUR

      Starts at the zeroth minute of the current hour and continues for 60 minutes.

    • TODAY

      Starts at 12:00:00 AM of the current day and continues for 24 hours.

    • THIS_WEEK

      Starts on Monday, 12:00:00 AM of the current week and continues for seven days.

    • THIS_MONTH

      Starts at 12:00:00 AM on the first day of the current month and continues for the duration of the month.

    • THIS_QUARTER

      Starts at 12:00:00 AM on the first day of the current calendar quarter and continues for the duration of the quarter.

    • THIS_YEAR

      Starts on January 1st, 12:00:00 AM of the current year and continues for the duration of the year.

    • PREVIOUS_HOUR

      Starts at the zeroth minute of the previous hour and continues for 60 minutes.

    • YESTERDAY

      Starts at 12:00:00 AM on the day before the today and continues for 24 hours.

    • PREVIOUS_WEEK

      Starts on Monday, 12:00:00 AM, a week before the current week, and continues for seven days.

    • PREVIOUS_MONTH

      Starts at 12:00:00 AM on the first day of the month before the current month and continues for the duration of the month.

    • PREVIOUS_QUARTER

      Starts at 12:00:00 AM on the first day of the calendar quarter before the current quarter and continues for the duration of the quarter.

    • PREVIOUS_YEAR

      Starts on January 1st, 12:00:00 AM, the year before the current year, and continues for the duration of the year.

    • NEXT_HOUR

      Starts at the zeroth minute of the next hour and continues for 60 minutes.

    • TOMORROW

      " Starts at 12:00:00 AM, the day after the current day, and continues for 24 hours.

    • NEXT_WEEK

      Starts on Monday, 12:00:00 AM, the week after the current week, and continues for the duration of the week.

    • NEXT_MONTH

      Starts at 12:00:00 AM on the first day of the next month and continues for the duration of the month.

    • NEXT_QUARTER

      Starts at 12:00:00 AM on the first day of the next calendar quarter and continues for the duration of the quarter.

    • NEXT_YEAR

      Starts on January 1st, 12:00:00 AM of the next year and continues for the duration of the year.

    • LAST_N_MINUTES

      Starts at the zeroth second n - 1 minute(s) before the current minute and continues through the current minute. It includes this minute.

    • LAST_N_HOURS

      Starts at the zeroth minute of the n - 1 hour(s) before the current hour, and continues through the current hour. It includes this hour.

    • LAST_N_DAYS

      Starts at 12:00:00 AM, n - 1 day(s) before the current day, and continues through the current day. It includes today.

    • LAST_N_WEEKS

      Starts on Monday, 12:00:00 AM, n - 1 week(s) before the current week, and continues through the current week. It includes this week.

    • LAST_N_MONTHS

      Starts at 12:00:00 AM on the first day of the month, n - 1 month(s) before the current month, and continues through the current month. It includes this month.

    • LAST_N_QUARTERS

      Starts at 12:00:00 AM on the first day of the calendar quarter n - 1 quarter(s) before the current quarter and continues through the current quarter. It includes this quarter.

    • LAST_N_YEARS

      Starts on January 1st, 12:00:00 AM of the year n - 1 year(s) before the current year and continues through the current year. It includes this year.

  • n optional Int

    The number of time units for the LAST_N relative periods.

  • start optional DateTime

    The optional start timestamp (inclusive). Defaults to the timestamp of the earliest record in the Data Pool.

  • stop optional DateTime

    The optional end timestamp (exclusive). Defaults to the timestamp of the latest record in the Data Pool.