General parameters

Device

parameterdescription
idthe device id can be retrieved by accessing the web platform and going to the device detail page (eg.: https://app.things5.digital/machines/4efe48f3-7619-4e27-826b-d710654adbc1 the 4efe48f3-7619-4e27-826b-d710654adbc1 is actually the device id)

Model

parameterdescription
idthe model id can be retrieved by accessing the web platform and going to the model detail page (eg.: https://staging.things5.digital/machines/models/234abc5d-a9c6-4ebc-aa11-883f2e103a33 the 234abc5d-a9c6-4ebc-aa11-883f2e103a33 is actually the model id)

Metrics, events, states

parameterdescription
namethe name of the variable, it can be retrieved by reading the device-specific configuration file, provided by the hardware manufacturer
fromdefine the start time boundary of your request
todefine the final boundary of your request
metric_namessee "name"
event_namessee "name"
states_namessee "name"

User

parameterdescription
usernamethe email with which the user has been registered to the platform
passwordthe password that the user has set to access the platform

Realm and organisation

parameterdescription
realm-idthe realm-id can be retrieved by going to the login page (es.: https://app.things5.digital) and reading the path between /realms/ and /protocol/ (es.: in https://auth.things5.digital/auth/realms/things5-production/protocol/openid-connect the realm-id is things5-production)