HomeGuidesAPI ReferenceChangelog
Log In
API Reference

DynamicSelector

a dynamic selector defines how datapoint(s) are fetched within a query.

It corresponds to a request to fetch datapoints dynamically based on metadata criteria. It must be used on a twin-based query.

Attributes

NameTypeDescription
categorystrfilter datapoints by unit category name.
unitstrfilter datapoints by unit name.
twin_typestrfilter datapoints by twin type.
agg_methodstraggregation method to use for selected datapoints.
renamestrrename the selected datapoints column in the output.
business_typestrfilter datapoints by BusinessType.
datapointslistresolved list of datapoints (populated after selection).

Methods

from_dict()

create a DynamicSelector from a dictionary.

NameTypeDefaultDescription
objdictdictionary representation.

from_json()

load the selector from a dict originating of a JSON format.

NameTypeDefaultDescription
objobject to load information from.

to_json()

convert the selector to a JSON-compatible dictionary.

return: dict representation.