IOionworks
Simulations

Get Simulation Result

Changed on

Get stored results for a simulation as JSON (legacy fallback).

New clients should download time_series.parquet and steps.parquet via the /time_series/download and /steps/download endpoints, which stream signed URLs straight from storage. This route remains for legacy simulations that predate storage_folder: it serves their JSONB data and triggers the re-run that upgrades them to parquet, returning 202 while that re-run is in flight.

Parameters

simulation_id : str ID of the simulation. user_org_client : tuple[str, str | None, AsyncClient] Current user_id, organization_id, and Supabase client. simulation_repository : SimulationRepository Repository for the simulations table. simulation_data_repository : SimulationDataRepository Repository for the legacy simulation_data table. target_rows : int | None If set, downsample the time series to at most this many rows. x_min : float | None Minimum Time [s] value to filter (for zoom). x_max : float | None Maximum Time [s] value to filter (for zoom).

Returns

dict Dictionary with time_series, steps, and metrics.

get/simulations/{simulation_id}/result

Request

  • Base URL
    https://api.ionworks.com
  • URL
    https://api.ionworks.com/simulations/{simulation_id}/result
  • Auth
    none declared

Path parameters

simulation_idstring uuid required

Query parameters

target_rowsinteger nullable
x_minnumber nullable
x_maxnumber nullable
x_columnstring

Response

Successful Response

unknown required

Changes