HomeGuidesAPI ReferenceChangelog
Log In
API Reference

Insight

An insight defines how display live data on control panel tiles.

Attributes

NameTypeDescription
namestrName of the insight displayed on the tile.

Methods

add_condition()

add a condition to the conditions.

NameTypeDefaultDescription
condition
return:

api_id()

return current object id on Web API format.

api_key()

return current object logical unique key (e.g. hardware_id, key, name).

returns None if the entity has no logical key.

clear_conditions()

endpoint()

return endpoint name used to contact backend.

from_json()

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

NameTypeDefaultDescription
objobject to load information from.

remove_condition()

NameTypeDefaultDescription
index

set_id()

specify the id_value neutrally

NameTypeDefaultDescription
id_value
return:

to_json()

transform current object into a dict that could be JSONIFY.

NameTypeDefaultDescription
targetstrNone
return: dumpable dict.

update_condition()

NameTypeDefaultDescription
index
condition