Skip to content

MetricState ​

Type: Object

A metric definition describing a trackable measurement

Fields ​

NameTypeArgsDescriptionDeprecated
createdAtString!Creation timestamp (ISO8601)
customUnitStringVertical-specific unit name when unit is CUSTOM (e.g. SHEETS, BOTTLES)
descriptionStringDescription of what this metric measures
deviceIdDeviceIDAssociated device ID
deviceNameStringResolved device name (read-only)
displayNameStringHuman-readable display name
idMetricID!Unique identifier
kindMetricKind!Metric kind (gauge, counter, status, rate)
nameString!Machine-readable metric name (e.g. door_open, ink_level)
resolvedUnitLabelString!Display-friendly unit label — returns customUnit for CUSTOM, otherwise the standard unit name
tags[Dictionary!]!Key-value metadata tags
unitMetricUnit!Measurement unit (CUSTOM when using a vertical-specific unit)
updatedAtString!Last update timestamp (ISO8601)
workCenterWorkCenterStateResolved work centre (via DataLoader)
workCenterIdWorkCenterIDAssociated work centre ID — enables filtering and cross-machine comparison

Relationships ​

Connect machines, automate workflows, and build custom apps for print production.