← API reference
CANONICAL TYPE REFERENCE

UpsertMetricInput

Input for creating or updating a metric

ID for update; omit for create

Associated device ID

Associated work centre ID — links this metric to a specific machine or station

nameString!

Machine-readable metric name (required)

Human-readable display name

Description of what this metric measures

Metric kind (required)

Measurement unit (required). Use CUSTOM for vertical-specific units.

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

Key-value metadata tags

View exact SDL
"""Input for creating or updating a metric"""
input UpsertMetricInput {
  """ID for update; omit for create"""
  id: MetricID
  """Associated device ID"""
  deviceId: DeviceID
  """
  Associated work centre ID — links this metric to a specific machine or station
  """
  workCenterId: WorkCenterID
  """Machine-readable metric name (required)"""
  name: String!
  """Human-readable display name"""
  displayName: String
  """Description of what this metric measures"""
  description: String
  """Metric kind (required)"""
  kind: MetricKind!
  """Measurement unit (required). Use CUSTOM for vertical-specific units."""
  unit: MetricUnit!
  """
  Vertical-specific unit name when unit is CUSTOM (e.g. SHEETS, BOTTLES). Required when unit is CUSTOM.
  """
  customUnit: String
  """Key-value metadata tags"""
  tags: [DictionaryInput!]
}

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