API Reference Test Suites Test Suite Runs

List Test Suite Executions

Beta

GET

Path parameters

idstringRequired

A UUID string identifying this test suite run.

Query parameters

expandstringOptional

The response fields to expand for more information.

‘results.metric_results.metric_label’ expands the metric label for each metric result.
‘results.metric_results.metric_definition’ expands the metric definition for each metric result.
‘results.metric_results.metric_definition.name’ expands the metric definition name for each metric result.

limitintegerOptional

Number of results to return per page.

offsetintegerOptional

The initial index from which to return the results.

Response

This endpoint returns an object

countinteger

resultslist of objects

nextstringOptional

previousstringOptional

GET

1 curl https://api.vellum.ai/v1/test-suite-runs/id/executions \
2      -H "X_API_KEY: <apiKey>"

200Retrieved

1 {
2   "count": 123,
3   "next": "http://api.example.org/accounts/?offset=400&limit=100",
4   "previous": "http://api.example.org/accounts/?offset=200&limit=100",
5   "results": [
6     {
7       "id": "id",
8       "test_case_id": "test_case_id",
9       "outputs": [
10         {
11           "type": "ARRAY",
12           "name": "outputs",
13           "output_variable_id": "outputs"
14         }
15       ],
16       "metric_results": [
17         {
18           "metric_id": "metric_id",
19           "outputs": [
20             {
21               "type": "ERROR",
22               "value": {
23                 "message": "message",
24                 "code": "INVALID_REQUEST"
25               },
26               "name": "outputs"
27             }
28           ]
29         }
30       ]
31     }
32   ]
33 }

Built with

1	curl https://api.vellum.ai/v1/test-suite-runs/id/executions \
2	-H "X_API_KEY: <apiKey>"

1	{
2	"count": 123,
3	"next": "http://api.example.org/accounts/?offset=400&limit=100",
4	"previous": "http://api.example.org/accounts/?offset=200&limit=100",
5	"results": [
6	{
7	"id": "id",
8	"test_case_id": "test_case_id",
9	"outputs": [
10	{
11	"type": "ARRAY",
12	"name": "outputs",
13	"output_variable_id": "outputs"
14	}
15	],
16	"metric_results": [
17	{
18	"metric_id": "metric_id",
19	"outputs": [
20	{
21	"type": "ERROR",
22	"value": {
23	"message": "message",
24	"code": "INVALID_REQUEST"
25	},
26	"name": "outputs"
27	}
28	]
29	}
30	]
31	}
32	]
33	}