Interface RecordAggregateRequest

Request for aggregating records from a stream

interface RecordAggregateRequest {
    aggregates: RecordAggregates;
    filter?: RecordFilter;
    includeTyping?: boolean;
    lastUpdatedTime?: LastUpdatedTimeFilter;
    targetUnits?: RecordTargetUnits;
}

Index

Properties

aggregates filter? includeTyping? lastUpdatedTime? targetUnits?

Properties

aggregates

aggregates: RecordAggregates

Dictionary of aggregates with client-defined identifiers

`Optional`filter

filter?: RecordFilter

Filter specification

`Optional`includeTyping

includeTyping?: boolean

When true, include property type information (and resolved units when combined with targetUnits).

`Optional`lastUpdatedTime

lastUpdatedTime?: LastUpdatedTimeFilter

Filter on last updated time. Required for immutable streams.

`Optional`targetUnits

targetUnits?: RecordTargetUnits

Convert float properties to another unit or unit system (response and filter values).