← API reference
CANONICAL TYPE REFERENCE

MetricState

A metric definition describing a trackable measurement

Unique identifier

Associated device ID

Resolved device name (read-only)

Associated work centre ID — enables filtering and cross-machine comparison

Resolved work centre (via DataLoader)

nameString!

Machine-readable metric name (e.g. door_open, ink_level)

Human-readable display name

Description of what this metric measures

Metric kind (gauge, counter, status, rate)

Measurement unit (CUSTOM when using a vertical-specific unit)

Vertical-specific unit name when unit is CUSTOM (e.g. SHEETS, BOTTLES)

Display-friendly unit label — returns customUnit for CUSTOM, otherwise the standard unit name

Key-value metadata tags

createdAtString!

Creation timestamp (ISO8601)

updatedAtString!

Last update timestamp (ISO8601)

View exact SDL
"""A metric definition describing a trackable measurement"""
type MetricState {
  """Unique identifier"""
  id: MetricID!
  """Associated device ID"""
  deviceId: DeviceID
  """Resolved device name (read-only)"""
  deviceName: String
  """
  Associated work centre ID — enables filtering and cross-machine comparison
  """
  workCenterId: WorkCenterID
  """Resolved work centre (via DataLoader)"""
  workCenter: WorkCenterState
  """Machine-readable metric name (e.g. door_open, ink_level)"""
  name: String!
  """Human-readable display name"""
  displayName: String
  """Description of what this metric measures"""
  description: String
  """Metric kind (gauge, counter, status, rate)"""
  kind: MetricKind!
  """Measurement unit (CUSTOM when using a vertical-specific unit)"""
  unit: MetricUnit!
  """Vertical-specific unit name when unit is CUSTOM (e.g. SHEETS, BOTTLES)"""
  customUnit: String
  """
  Display-friendly unit label — returns customUnit for CUSTOM, otherwise the standard unit name
  """
  resolvedUnitLabel: String!
  """Key-value metadata tags"""
  tags: [Dictionary!]!
  """Creation timestamp (ISO8601)"""
  createdAt: String!
  """Last update timestamp (ISO8601)"""
  updatedAt: String!
}

One stable address across all schema views. Follow a field’s type to explore connections between domains.