Trigger test metric execution
Trigger execution of a metric against a simulation output for testing purposes. This is an asynchronous operation that returns immediately with a metric output ULID.
Retrieving the result: poll
GET /v1/simulations/{simulation_id}/metrics/{metric_output_id} using the
simulation_output_id you passed here as simulation_id and 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 results belong to the simulation they ran against, so they
are not available on the conversations endpoint.
Authorizations
API key for authentication
Path Parameters
The metric ID (22-character ShortUUID)
^[a-zA-Z0-9]{22}$Body
Response
Test metric execution queued successfully
The ULID of the created metric output, used to track result
26^[0-9A-HJKMNP-TV-Z]{26}$