Test Suite Runs

List 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
count
integer
results
list of objects
next
stringOptional
previous
stringOptional
GET
1curl https://api.vellum.ai/v1/test-suite-runs/id/executions \
2     -H "X_API_KEY: <apiKey>"
200
Retrieved
1{
2  "count": 123,
3  "results": [
4    {
5      "id": "id",
6      "test_case_id": "test_case_id",
7      "outputs": [],
8      "metric_results": [
9        {
10          "metric_id": "metric_id",
11          "outputs": []
12        }
13      ]
14    }
15  ],
16  "next": "http://api.example.org/accounts/?offset=400&limit=100",
17  "previous": "http://api.example.org/accounts/?offset=200&limit=100"
18}
Built with