List Test Suite Executions

import requests
url = "https://api.vellum.ai/v1/test-suite-runs/id/executions"
headers = {"X-API-KEY": "<apiKey>"}
response = requests.get(url, headers=headers)
print(response.json())

{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    {
      "id": "string",
      "test_case_id": "string",
      "outputs": [
        {
          "name": "string",
          "type": "STRING",
          "value": "string",
          "output_variable_id": "string"
        }
      ],
      "metric_results": [
        {
          "metric_id": "string",
          "outputs": [
            {
              "value": "string",
              "type": "STRING",
              "name": "string"
            }
          ],
          "metric_label": "string",
          "metric_definition": {
            "id": "string",
            "label": "string",
            "name": "string"
          }
        }
      ]
    }
  ]
}

import requests
url = "https://api.vellum.ai/v1/test-suite-runs/id/executions"
headers = {"X-API-KEY": "<apiKey>"}
response = requests.get(url, headers=headers)
print(response.json())

{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    {
      "id": "string",
      "test_case_id": "string",
      "outputs": [
        {
          "name": "string",
          "type": "STRING",
          "value": "string",
          "output_variable_id": "string"
        }
      ],
      "metric_results": [
        {
          "metric_id": "string",
          "outputs": [
            {
              "value": "string",
              "type": "STRING",
              "name": "string"
            }
          ],
          "metric_label": "string",
          "metric_definition": {
            "id": "string",
            "label": "string",
            "name": "string"
          }
        }
      ]
    }
  ]
}

Authentication

X-API-KEYstring

API Key authentication via header

Path parameters

idstringRequiredformat: "uuid"

A UUID string identifying this test suite run.

Query parameters

expandlist of stringsOptional

The response fields to expand for more information.

‘metric_results.metric_label’ expands the metric label for each metric result.
‘metric_results.metric_definition’ expands the metric definition for each metric result.
‘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

countinteger

nextstring or nullformat: "uri"

previousstring or nullformat: "uri"

resultslist of objects

List Test Suite Executions

Authentication

Path parameters

Headers

Query parameters

Response

Authentication

Path parameters

Headers

Query parameters

Response

1	import requests
2
3	url = "https://api.vellum.ai/v1/test-suite-runs/id/executions"
4
5	headers = {"X-API-KEY": "<apiKey>"}
6
7	response = requests.get(url, headers=headers)
8
9	print(response.json())

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": "string",
8	"test_case_id": "string",
9	"outputs": [
10	{
11	"name": "string",
12	"type": "STRING",
13	"value": "string",
14	"output_variable_id": "string"
15	}
16	],
17	"metric_results": [
18	{
19	"metric_id": "string",
20	"outputs": [
21	{
22	"value": "string",
23	"type": "STRING",
24	"name": "string"
25	}
26	],
27	"metric_label": "string",
28	"metric_definition": {
29	"id": "string",
30	"label": "string",
31	"name": "string"
32	}
33	}
34	]
35	}
36	]
37	}