โ† API reference
Subscription / jobs

scenarioSimulationProgress

Stream progress events for a simulation run. The first event reflects the persisted state, so a subscriber joining after the run ended receives its terminal status and the stream finishes. Requires scenarioSimulationRun:read permission.

Arguments

The run to follow

Returns SimulationProgressEvent!

Scalar fields at a glance

completedSamplesInt!
totalSamplesInt!
errorString
โ†— View the complete SimulationProgressEvent type

Explore in a view

Production Floor
View exact SDL
"""
Stream progress events for a simulation run. The first event reflects the persisted state, so a subscriber joining after the run ended receives its terminal status and the stream finishes. Requires scenarioSimulationRun:read permission.
"""
scenarioSimulationProgress(
  """The run to follow"""
  runId: ScenarioSimulationRunID!
): SimulationProgressEvent! @topic(names: ["jobs"])

Schema reference describes the API contract. Actual access is checked by the platform for every operation.