Test Suite Details

API Explorer: /multi-tests/{collectionId}

To return the details of a specific test suite, a collectionId is required. The sample code returns the test suite details for a collectionId of 12345678. Use the actual ID value for the test suite to return the detail of that test suite.

If you do not know the collectionId of the test suite, use List Test Suites to return a list of your created test suites.

Test Suite Details

curl 'https://a.blazemeter.com/api/v4/multi-tests/12345678?populateTests=true' \
    --user 'api_key_id:api_key_secret'

Test Suite Details Parameters

Parameters

  • populateTests boolean

    Denotes if the response will show the included test details within the test suite response

Test Suite Details Response Attributes

For the all the supported attributes, see the The Multi-Test Object.

Response200 OK

{
    "api_version": 4,
    "error": null,
    "result": {
        "id": 12345678,
        "name": "Functional Test Validation",
        "description": null,
        "collectionType": "functionalTestSuite",
        "userId": 123456,
        "items": [],
        "oldVersionId": null,
        "lastRunTime": 1586202190,
        "draftId": null,
        "filesToSplit": [],
        "dataFiles": [],
        "creatorClientId": "gui",
        "testsForExecutions": [
            {
                "testId": 1234567,
                "executions": [
                    {
                        "concurrency": 1,
                        "iterations": 1,
                        "locations": {
                            "harbor-5b86c7f5e86da28c337b23c6": 1
                        },
                        "locationsWeighted": true,
                        "executor": "selenium",
                        "testId": 1234567,
                        "scenario": "Scenario 1"
                    }
                ],
                "overrideExecutions": []
            },
            {
                "testId": 2345678,
                "executions": [
                    {
                        "concurrency": 1,
                        "iterations": 1,
                        "locations": {
                            "harbor-5b0323b3c648be3b4c7b23c8": 1
                        },
                        "locationsWeighted": true,
                        "testId": 2345678,
                        "scenario": "My Scenario"
                    }
                ],
                "overrideExecutions": [
                    {
                        "iterations": 1,
                        "executor": "taurus"
                    }
                ]
            }
        ],
        "migratedFromTestCollectionId": null,
        "migratedToTestId": null,
        "v4MigratedDate": null,
        "underMigration": null,
        "shouldSendReportEmail": true,
        "created": 1586202000,
        "updated": 1592571681,
        "note": null,
        "projectId": 123456,
        "lastUpdatedById": null,
        "kpiTrackingData": null,
        "tests": [
            {
                "id": 1234567,
                "isNewTest": true,
                "lastRunTime": 1587683984,
                "name": "GUI Functional Validation Test",
                "userId": 123456,
                "creatorClientId": "gui",
                "overrideExecutions": [],
                "executions": [
                    {
                        "iterations": 1,
                        "locations": {
                            "harbor-5b86c7f5e86da28c337b23c6": 1
                        },
                        "locationsWeighted": true,
                        "executor": "selenium",
                        "scenario": "Scenario 1",
                        "concurrency": 1
                    }
                ],
                "shouldSendReportEmail": false,
                "dependencies": [],
                "created": 1579700364,
                "updated": 1587683980,
                "configuration": {
                    "type": "functionalGui",
                    "dedicatedIpsEnabled": false,
                    "canControlRampup": false,
                    "targetThreads": 0,
                    "enableMockServices": false,
                    "scriptType": "taurus",
                    "filename": "test.yaml",
                    "testMode": "script"
                },
                "fileErrors": []
            },
            {
                "id": 2345678,
                "isNewTest": true,
                "lastRunTime": 1592571681,
                "name": "API Functional Validation Test",
                "userId": 123456,
                "creatorClientId": "gui",
                "overrideExecutions": [
                    {
                        "iterations": 1,
                        "executor": "taurus"
                    }
                ],
                "executions": [
                    {
                        "concurrency": 1,
                        "iterations": 1,
                        "locations": {
                            "harbor-5b0323b3c648be3b4c7b23c8": 1
                        },
                        "locationsWeighted": true,
                        "scenario": "My Scenario"
                    }
                ],
                "shouldSendReportEmail": false,
                "dependencies": [],
                "created": 1586201920,
                "updated": 1592571681,
                "configuration": {
                    "type": "functionalApi",
                    "canControlRampup": false,
                    "targetThreads": 0,
                    "enableMockServices": false,
                    "scriptType": "taurus",
                    "filename": "blazemeterscript.yaml",
                    "testMode": "http",
                    "extraSlots": 0
                },
                "fileErrors": []
            }
        ],
        "masters": [
            {
                "id": 12345678,
                "name": "Functional Test Validation",
                "userId": 123456,
                "ended": 1586202434,
                "lastUpdate": 1586202211,
                "delayedStartReady": true,
                "runnerUserId": 123456,
                "charges": [],
                "terminateWorkersExecuted": false,
                "hasData": true,
                "passed": true,
                "parallelTestsInWorkspace": 2,
                "parallelTestsInAccount": 2,
                "isPrivateData": false,
                "executionMode": "functional",
                "creatorClientId": "gui",
                "executorClientId": "gui",
                "secondsPerLabelDoc": 60,
                "labelsCollectionSuffix": "_17_12",
                "locations": [
                    "harbor-5d25f94f9950ce73cd105f53",
                    "harbor-58d3b97ff132adc0347b23c6"
                ],
                "scenariosMapping": [
                    {
                        "id": "0d0893db262df70451440cc9fafb1cb29e953ab538fb5d985b15892e1975232e",
                        "name": "Scenario 1",
                        "test": "GUI Functional Validation Test",
                        "isEndUserExperience": false
                    },
                    {
                        "id": "3b72f4fdbd4000b35e51e4d4db89fe2a02ea2f34f504bfd2c069e6de535f4c62",
                        "name": "My Scenario",
                        "test": "API Functional Validation Test",
                        "isEndUserExperience": false
                    }
                ],
                "isDebugRun": false,
                "executions": [
                    {
                        "concurrency": 1,
                        "holdFor": "42720s",
                        "locations": {
                            "harbor-5d25f94f9950ce73cd105f53": 1
                        },
                        "locationsWeighted": true,
                        "executor": "selenium",
                        "testId": 1234567,
                        "scenario": "Scenario 1"
                    },
                    {
                        "concurrency": 1,
                        "holdFor": "42720s",
                        "iterations": 1,
                        "locations": {
                            "harbor-58d3b97ff132adc0347b23c6": 1
                        },
                        "locationsWeighted": true,
                        "testId": 2345678,
                        "scenario": "My Scenario"
                    }
                ],
                "concurrency": 1,
                "useV4Pipeline": false,
                "v4IndexerCollection": "{\"execution\":[1],\"execution:1\":[\"r-v4-5e8b864e574e1\",\"r-v4-5e8b864e68567\"],\"session:1\":[\"r-v4-5e8b864e574e1\",\"r-v4-5e8b864e68567\"],\"location:1\":[\"harbor-5d25f94f9950ce73cd105f53\",\"harbor-58d3b97ff132adc0347b23c6\"]}",
                "isSelenium": true,
                "rpsCompatible": false,
                "remoteControlCompatible": false,
                "hasMonitoringData": true,
                "shouldSendReportEmail": true,
                "shouldUseDaggerReport": false,
                "hasDaggerData": false,
                "kinesisStream": "prod-blue_v4pipeline_input",
                "useJetlag": false,
                "jetpackLabels": [],
                "dependencies": [
                    []
                ],
                "env": "https://a.blazemeter.com",
                "created": 1586202190,
                "updated": 1586202736,
                "functionalSummary": {
                    "testsCount": 1,
                    "requestsCount": 1,
                    "errorsCount": 0,
                    "assertions": {
                        "count": 1,
                        "passed": 1
                    },
                    "responseTime": {
                        "sum": 558
                    },
                    "failedCount": 0,
                    "failedPercentage": 100
                },
                "gridSummary": {
                    "uniqueTestCasesCount": 1,
                    "uniqueSuitesCount": 1,
                    "passedTestCasesCount": 1,
                    "failedTestCasesCount": 0,
                    "brokenTestCasesCount": 0,
                    "totalTestCasesCount": 1,
                    "undefinedTestCasesCount": 0,
                    "testCasesCount": 1,
                    "passedPercent": 1,
                    "started": 1586202407,
                    "ended": 1586202412,
                    "definedStatus": "passed"
                },
                "testSuiteSummary": {
                    "testsResult": [
                        {
                            "testId": 1234567,
                            "testName": "GUI Functional Validation Test",
                            "testType": "functionalGui",
                            "definedStatus": "passed",
                            "suitesPassed": 1,
                            "suitesTotal": 1,
                            "sessionsPassed": 1,
                            "sessionsTotal": 1,
                            "started": 1586202407.4205379,
                            "ended": 1586202412.6374972
                        },
                        {
                            "testId": 2345678,
                            "testName": "API Functional Validation Test",
                            "testType": "functionalApi",
                            "started": 1586202190,
                            "ended": 1586202408,
                            "definedStatus": "passed",
                            "suitesPassed": 1,
                            "suitesTotal": 1,
                            "sessionsPassed": 1,
                            "sessionsTotal": 1
                        }
                    ],
                    "uniqueLocationNames": [
                        "EU West (London) - Functional GUI Test",
                        "Functional Testing Default Location"
                    ],
                    "suiteSummary": {
                        "suitesPassed": 2,
                        "suitesTotal": 2,
                        "sessionsPassed": 2,
                        "sessionsTotal": 2,
                        "definedStatus": "passed",
                        "started": 1586202190,
                        "ended": 1586202412.6374972
                    },
                    "updated": 1586202736
                }
            }
        ]
    },
    "request_id": "5ef0e123710ba"
}