---
title: "Get simulation unit test set runs"
method: GET
path: "/v1/{organization}/simulation/unit_test_set_run/"
tags: ["Simulation"]
---

# Get simulation unit test set runs

`GET /v1/{organization}/simulation/unit_test_set_run/`

Retrieves simulation unit test set runs.

This endpoint may be impacted by the following permissions:
* Only the runs that the authenticated user has the `Simulation:GetSimulationUnitTestSetRun` permission for will be returned.
* The `unit_test_run_specs` and `unit_test_run_results` fields are only populated if the authenticated user has the `Simulation:GetSimulationUnitTestSet` permission.
* The fields `scenario_version_info`, `persona_version_info`, `metrics_to_evaluate` in `unit_test_run_specs` and the field `metric_evaluation_results` in `unit_test_run_results` are only populated if the authenticated user has the `Simulation:GetSimulationUnitTest` permission.

## Path parameters

- `organization` string, required

## Query parameters

- `id` string[] — The ID of the simulation unit test set run to retrieve.
- `limit` integer — The maximum number of simulation unit test set runs to return.
- `continuation_token` integer — The continuation token from the previous request used to retrieve the next page of simulation unit test set runs.
- `creator` string[] — The creators of the simulation unit test set runs to retrieve. Each value must be of the format `org_id,user_id`.
- `sort_by` string[] — The fields to sort the sets by. Supported fields are `created_at`.
- `simulation_unit_test_set_id` string[] — The IDs of the simulation unit test sets that the simulation unit test set runs belong to.
- `is_completed` boolean, nullable — Whether the simulation unit test set run is completed.
- `failed_metrics` boolean, nullable — Whether the simulation unit test set run has failed due to failing metrics. Note that this field could be `True` even if the run is still ongoing -- it simply means some unit test runs have failed.
- `errored` boolean, nullable — Whether the simulation unit test set run has encountered an error.
- `created_after` string, date-time, nullable — Filter for simulation unit test set runs created at or after this time (inclusive).
- `created_before` string, date-time, nullable — Filter for simulation unit test set runs created at or before this time (inclusive).

## Headers

- `x-mongo-cluster-name` string, nullable — The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.
- `Sec-WebSocket-Protocol` string[]

## Response `200`

Succeeded.

- SrcAppEndpointsSimulationGetSimulationUnitTestSetRunsResponse
  - `simulation_unit_test_set_runs` SimulationUnitTestSetRunInstance[], required — The retrieved simulation unit test set runs. — unresolved $ref
  - `has_more` boolean, required — Whether there are more simulation unit test set runs to retrieve.
  - `continuation_token` integer, nullable, required — The continuation token to use to retrieve the next page of simulation unit test set runs.
  - `filter_values` SrcAppEndpointsSimulationGetSimulationUnitTestSetRunsResponseFilterValues, required
    - `creators` AmigoLibMongoCollectionsSimulationUnitTestSetRunSimulationUnitTestSetRunUserInfo[], required — A set of creator infos that created the simulation unit test set runs under the current filters.
      - `org_id` string, required
      - `user_id` string, required
    - `simulation_unit_test_set_ids` string[], required — A set of simulation unit test set IDs that the simulation unit test set runs belong to.
    - `tags` string[], required — A set of tag keys that exist in the simulation unit test set runs under the current filters.

## Other responses

- `401` — Invalid authorization credentials.
- `403` — Missing required permissions.
- `404` — Specified organization is not found.
- `422` — Invalid request path parameter or request query parameter failed validation.
- `429` — The user has exceeded the rate limit of 50 requests per minute for this endpoint.
- `503` — The service is going through temporary maintenance.

---

[API](https://skmtc.net/amigo/apis/amigo-api.md) · [All operations](https://skmtc.net/amigo/apis/amigo-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/amigo/amigo-api/revisions/f0f28319e448/schema)