Fetch test suite results

GET/test_runs/{run_id}/test_suite_results/{suite_result_id}

Base URL https://app.testsigma.com/api/v2Region

Fetch the execution results for a specific test suite within a test plan run.

Authenticate with your API key as a Bearer token in the Authorization header. How to authenticate →

Path parameters

`run_id`	The test plan run ID.
`suite_result_id`	The test suite result ID to fetch.

Query parameters

query Filter using <parameter><operator><value> chained with commas, e.g. query=testPlanId:1,result:PASSED

Response attributes

`id`	Test suite result ID.
`testRunId`	ID of the parent test run.
`result`	Result for this suite.
`startTime`	Suite run start time.
`endTime`	Suite run end time.
`duration`	Duration in milliseconds.
`deviceConfiguration`	Device configuration for the suite run, if any.
`metrics`	Object with aggregated pass/fail/count metrics for the suite.
`appDetails`	Application details for the run, if any.

Request

curl -X GET \
  'https://app.testsigma.com/api/v2/test_runs/{run_id}/test_suite_results/{suite_result_id}' \
  -H 'Authorization: Bearer <API_KEY>' \
  -H 'Content-Type: application/json'

const response = await fetch('https://app.testsigma.com/api/v2/test_runs/{run_id}/test_suite_results/{suite_result_id}', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer <API_KEY>',
    'Content-Type': 'application/json'
  }
});
const data = await response.json();

import requests

response = requests.get(
  'https://app.testsigma.com/api/v2/test_runs/{run_id}/test_suite_results/{suite_result_id}',
  headers={
    'Authorization': 'Bearer <API_KEY>',
    'Content-Type': 'application/json'
  }
)
data = response.json()

Response200 OK

{
  "id": 1383,
  "testRunId": 517,
  "result": "FAILURE",
  "startTime": "2024-05-29T07:29:19Z",
  "endTime": "2024-05-29T07:30:33Z",
  "duration": 74000,
  "deviceConfiguration": null,
  "metrics": {
    "id": 293,
    "testDeviceResultId": 1434,
    "testPlanResultId": 517,
    "totalCount": 2,
    "failedCount": 1,
    "passedCount": 1,
    "stoppedCount": 0,
    "notExecutedCount": 0,
    "queuedCount": 0,
    "runningCount": 0,
    "consolidatedTotalCount": 2,
    "consolidatedFailedCount": 1,
    "consolidatedPassedCount": 1,
    "consolidatedStoppedCount": 0,
    "consolidatedNotExecutedCount": 0,
    "consolidatedQueuedCount": 0,
    "consolidatedRunningCount": 0,
    "result": "FAILURE",
    "latestResult": "FAILURE",
    "duration": 62000,
    "consolidatedDuration": 62000
  },
  "appDetails": null
}

Was this page helpful?