MetricState
A metric definition describing a trackable measurement
Fields
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)
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)
Possible values (4)
GAUGEInstantaneous value that can go up or down (temperature, speed, ink level)
COUNTERMonotonically increasing cumulative value (total impressions, error count)
STATUSDiscrete state as a numeric value (0/1 for door open/closed, online/offline)
RATEComputed rate of change (pages per minute, waste per hour)
Measurement unit (CUSTOM when using a vertical-specific unit)
Possible values (39)
NONENo unit
PERCENTPercentage (0-100)
RATIORatio (0.0-1.0)
BOOLEANBoolean (0 or 1)
COUNTGeneric count
PIECESDiscrete pieces/items
MILLIMETERSMillimeters
METERSMeters
INCHESInches
FEETFeet
METERS_PER_MINUTEMeters per minute
FEET_PER_MINUTEFeet per minute
UNITS_PER_MINUTEUnits per minute (generic)
UNITS_PER_HOURUnits per hour (generic)
CELSIUSDegrees Celsius
FAHRENHEITDegrees Fahrenheit
KELVINKelvin
BARBar
PSIPounds per square inch
KILOPASCALKilopascal
GRAMSGrams
KILOGRAMSKilograms
POUNDSPounds
MILLILITERSMilliliters
LITERSLiters
SQUARE_METERSSquare meters
SQUARE_FEETSquare feet
MILLISECONDSMilliseconds
SECONDSSeconds
MINUTESMinutes
HOURSHours
VOLTSVolts
AMPSAmperes
WATTSWatts
KILOWATT_HOURSKilowatt-hours
BYTESBytes
KILOBYTESKilobytes
MEGABYTESMegabytes
CUSTOMVertical-specific or user-defined unit — provide the unit name in customUnit
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
Creation timestamp (ISO8601)
Last update timestamp (ISO8601)
Referenced by (3)
Exact type 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!
}