Retrieve Test Suite Run

Retrieve a specific Test Suite Run by ID

X-API-KEYstring

API Key authentication via header

idstringRequiredformat: "uuid"

A UUID string identifying this test suite run.

idstringformat: "uuid"

createdstringformat: "date-time"

test_suiteobject

stateenum

The current state of this run

Allowed values:

exec_configobject or null

Configuration that defines how the Test Suite should be run

progressobject

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

1	{
2	"id": "string",
3	"created": "2024-01-15T09:30:00Z",
4	"test_suite": {
5	"id": "string",
6	"history_item_id": "string",
7	"label": "string"
8	},
9	"state": "QUEUED",
10	"exec_config": {
11	"type": "DEPLOYMENT_RELEASE_TAG",
12	"data": {
13	"deployment_id": "string",
14	"tag": "LATEST"
15	},
16	"test_case_ids": [
17	"string"
18	]
19	},
20	"progress": {
21	"number_of_requested_test_cases": 1,
22	"number_of_completed_test_cases": 1
23	}
24	}

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

1	{
2	"id": "string",
3	"created": "2024-01-15T09:30:00Z",
4	"test_suite": {
5	"id": "string",
6	"history_item_id": "string",
7	"label": "string"
8	},
9	"state": "QUEUED",
10	"exec_config": {
11	"type": "DEPLOYMENT_RELEASE_TAG",
12	"data": {
13	"deployment_id": "string",
14	"tag": "LATEST"
15	},
16	"test_case_ids": [
17	"string"
18	]
19	},
20	"progress": {
21	"number_of_requested_test_cases": 1,
22	"number_of_completed_test_cases": 1
23	}
24	}