Skip to main content

timeSeries

Query a Metric in time series format. Arrays of timestamps and Metric values for the given time range and filters.

Arguments

  • input required TimeSeriesInput

    The fields for querying a Metric in time series format.

    A Metric's time series query returns the values over a given time range aggregated by a given time granularity; day, month, or year, for example.

    • input.metric optional MetricInput

      The Metric to Query. It can be a pre-created one or it can be inlined here.

    • input.timeRange required TimeRangeInput

      The time range for calculating the time series.

    • input.timeZone optional String

      The time zone to use. Dates and times are always returned in UTC, but setting the time zone influences relative time ranges and granularities.

      You can set this to "America/Los_Angeles", "Europe/Berlin", or any other value in the IANA time zone database. Defaults to "UTC".

    • input.granularity required TimeSeriesGranularity

      The time granularity (hour, day, month, etc.) to aggregate the Metric values by.

      The available time series granularities. Granularities define the unit of time to aggregate the Metric data for a time series query.

      For example, if the granularity is set to DAY, then the the time series query will return a label and a value for each day.

      If there are no records for a given time series granularity, Propel will return the label and a value of "0" so that the time series can be properly visualized.

      • MINUTE

        Aggregates values by minute intervals.

      • FIVE_MINUTES

        Aggregates values by 5-minute intervals.

      • TEN_MINUTES

        Aggregates values by 10-minute intervals.

      • FIFTEEN_MINUTES

        Aggregates values by 15-minute intervals.

      • HOUR

        Aggregates values by hourly intervals.

      • DAY

        Aggregates values by daily intervals.

      • WEEK

        Aggregates values by weekly intervals.

      • MONTH

        Aggregates values by monthly intervals.

      • YEAR

        Aggregates values by yearly intervals.

    • input.filters optional array of FilterInput

      The Query Filters to apply before retrieving the time series data. If no Query Filters are provided, all data is included.

    • input.propeller optional Propeller

      Optionally specifies the Propeller to use. This can be set by Users when querying from the Metric Playground or GraphQL Explorer. Applications may not set this value. Instead, Application Queries always use the Propeller configured on the Application.

      A Propeller determines your Application's query processing power. The larger the Propeller, the faster the queries and the higher the cost. Every Propel Application (and therefore every set of API credentials) has a Propeller that determines the speed and cost of queries.

      Learn more about Data Sources.

      • P1_X_SMALL

        Max records per second: 5,000,000 records per second

      • P1_SMALL

        Max records per second: 25,000,000 records per second

      • P1_MEDIUM

        Max records per second: 100,000,000 records per second

      • P1_LARGE

        Max records per second: 250,000,000 records per second

      • P1_X_LARGE

        Max records per second: 500,000,000 records per second


Returns

Nullable TimeSeriesResponse

The time series response object. It contains an array of time series labels and an array of Metric values for the given time range and Query Filters.