Telemetry Signal Parameters

Historical Signal Parameters

The /telemetry/history route provides data organized by site. Query parameters for the /telemetry/history endpoint include:

  • target_id: (Required) UUID of group or site to query, when queried with a group UUID, data will be returned in list of sites that are descendants of that group.
  • signals: (Required) comma-separated list of signals as described in Appendix A: Available Site-Level Signals or Appendix B: Available Device-Level Signals
  • start_datetime: (Required) Beginning time index to search. Must be in IS08601 date and time combined representation format. Example 2017-01-27T08:45:00Z. Should include the time zone offset (UTC time used here, as indicated by the Z), it may include milliseconds.
  • period: (Optional) This parameter defines the time interval for which raw telemetry data is aggregated. Permitted interval units include seconds, minutes, hours, and days. You can use any positive integer and time unit (s, m, h, d, w) combination. There is no support for month or year units. If the period is specified, the rollup must also be specified. Examples include:
    • 15m
    • 5h
    • 2d
    • 1w
  • rollup: (Optional) This parameter defines the function applied to the raw telemetry for the period specified. If the rollup is specified, the period must also be specified. The options include:
    • sum
    • mean
    • max
    • min
    • first
    • last
  • fill: (Optional) This parameter defines the function used for specified periods which contain no raw telemetry data. If even some of the raw telemetry data is available for the specified period, then the following fill function does not apply. Periods that contain no data can be reported by the following methods:
    • none - Reports no timestamp and no value for the periods with no data
    • null - Reports null for the periods with no data but returns a timestamp
    • previous - Reports the value from the previous period for the adjacent time intervals with no data
    • linear - Performs linear interpolation between the adjacent periods for the period with no data
  • time_zone: (Optional) Allows the client to receive data adjusted to their preferred time_zone. The time zone offset in the start_datetime must match the time_zone specified here. Available time zones must be in the TZ database format specified here: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List

If the Period and Rollup are not specified, the period will default to the following:

  • For historical data within the last three days, the period of the signal in the query that has the highest resolution
  • For historical data more than three days old, 5 minutes