Interface LatestDataPropertyFilter

interface LatestDataPropertyFilter {
    before?: string | number | Date;
    ignoreBadDataPoints?: boolean;
    includeStatus?: boolean;
    targetUnit?: string;
    targetUnitSystem?: string;
    treatUncertainAsBad?: boolean;
}

Properties

before? ignoreBadDataPoints? includeStatus? targetUnit? targetUnitSystem? treatUncertainAsBad?

Properties

Optionalbefore

before?: string | number | Date

Get first datapoint before this time. Format is N[timeunit]-ago where timeunit is w,d,h,m,s. Example: '2d-ago' will get everything that is up to 2 days old. Can also send time as a Date object or number of milliseconds since epoch.

OptionalignoreBadDataPoints

ignoreBadDataPoints?: boolean

Treat data points with Bad status codes as if they do not exist. Set to false to include bad data points.

Default

true

OptionalincludeStatus

includeStatus?: boolean

Include status codes in the response. Good (code 0) status codes are always omitted.

Default

false

OptionaltargetUnit

targetUnit?: string

The unit externalId of the data points returned. If the time series does not have a unitExternalId that can be converted to the targetUnit, an error will be returned. Cannot be used with targetUnitSystem.

OptionaltargetUnitSystem

targetUnitSystem?: string

The unit system of the data points returned. Cannot be used with targetUnit.

OptionaltreatUncertainAsBad

treatUncertainAsBad?: boolean

Treat data points with Uncertain status codes as Bad.

Default

true

Settings

Member Visibility

On This Page

Properties