GetTimeSeriesDataParams

Defined in: src/types/time_series.ts:8

Parameters for querying aggregated time series data.

Properties

aggregate?

optional aggregate?: string

Defined in: src/types/time_series.ts:14

Aggregation function (e.g., “avg”, “min”, “max”, “count”).

aggregation_interval?

optional aggregation_interval?: string

Defined in: src/types/time_series.ts:16

Interval for aggregation (e.g., “hour”, “day”, “week”).

desc_order?

optional desc_order?: boolean

Defined in: src/types/time_series.ts:22

Whether to return results in descending order.

differential?

optional differential?: boolean

Defined in: src/types/time_series.ts:18

Whether to compute differential values.

end_time?

optional end_time?: number

Defined in: src/types/time_series.ts:30

End of the time range (epoch seconds).

node_id

node_id: string

Defined in: src/types/time_series.ts:10

Node ID to fetch time series data for.

num_intervals?

optional num_intervals?: number

Defined in: src/types/time_series.ts:32

Number of aggregation intervals to return.

num_records?

optional num_records?: number

Defined in: src/types/time_series.ts:36

Maximum number of records to return.

param_name

param_name: string

Defined in: src/types/time_series.ts:12

Parameter name to query.

reset_on_negative?

optional reset_on_negative?: boolean

Defined in: src/types/time_series.ts:20

Whether to reset accumulated value on negative deltas.

start_id?

optional start_id?: string

Defined in: src/types/time_series.ts:34

ID to start pagination from.

start_time?

optional start_time?: number

Defined in: src/types/time_series.ts:28

Start of the time range (epoch seconds).

timezone?

optional timezone?: string

Defined in: src/types/time_series.ts:38

Timezone for aggregation boundaries.

type?

optional type?: string

Defined in: src/types/time_series.ts:24

Data type filter.

week_start?

optional week_start?: string

Defined in: src/types/time_series.ts:26

Day the week starts on for weekly aggregation.