Get simulation metric output(s)
Retrieve metric output(s) for a simulation by ID. The path segment accepts two ID types and returns different response shapes:
- 26-char MetricOutput ULID: returns a single metric output as
{ "metric": {...} }. - 22-char Metric definition ID: returns every output for that
metric on the simulation as
{ "metric_outputs": [...] }.
Clients should branch on the input ID length they passed.
Retrieving test-metric results: after calling
POST /v1/metrics/{metric_id}/test, poll this endpoint using the same
simulation output ID you tested against as simulation_id, plus the
returned 26-char metric_output_ulid. The response includes a status
field (IN QUEUE, IN PROGRESS, COMPLETED, FAILED) — poll until it
is terminal. Test-metric outputs belong to the simulation they ran
against, so they are retrieved here, not via the conversations endpoint.
Authorizations
API key for authentication.
Path Parameters
The simulation ID
22 - 27Either a 26-char MetricOutput ULID or a 22-char Metric definition ID. See endpoint description for response shape per ID type.
22 - 26Response
Metric output details. Single object when called with a 26-char ULID, collection object when called with a 22-char metric_id.
- Option 1
- Option 2
Single metric output (returned when {metric_output_id} is a 26-char ULID)