Start a Multi-Test

API Explorer: /multi-tests/{collectionId}/start

To start a preconfigured load test, you need to know the collectionId of a created and configured test. The sample code executes a test with a collectionId of 12345678. Use the collectionId of the actual test to start in place of the 12345678.

You can create and configure the test through the UI or through the API.
The first id returned in the response is a masterId. You can use this ID as a reference to this instance of a test launch. For example, send it using the Stop a Test Run API to stop this running instance.

If you do not know the ID of the test to start, use List Multi-Tests to return a list of your created tests.

You can also get the scenarioId and location id from this response, which can be used to narrow down your results by the scenario or location. This is covered, in detail, in the the Test Results Advanced Settings section.

Start a Multi-Test 


curl 'https://a.blazemeter.com/api/v4/multi-tests/12345678/start?delayedStart=true' \
	-X POST \
	-H 'Content-Type: application/json' \
	--user 'api_key_id:api_key_secret'

Start a Multi-Test Parameters

Parameters

  • delayedStart boolean

    Denotes if the test run will wait to start for a set amount of time after all engines are ready

Start a Multi-Test Response Attributes

For the full details of all the attributes for the test run response, you can visit The Master Object.

Response202 Accepted 

{
    "api_version": 4,
    "error": null,
    "result": {
        "id": 12345678,
        "name": "March_08_9:49 AM - Multi-Test",
        "userId": 123456,
        "publicToken": null,
        "ended": null,
        "lastUpdate": null,
        "delayedStartReady": false,
        "runnerUserId": 123456,
        "charges": [],
        "usage": null,
        "maxUsers": null,
        "type": null,
        "passed": null,
        "canControlRampup": null,
        "targetThreads": null,
        "parallelTestsInWorkspace": 1,
        "parallelTestsInAccount": 1,
        "isSandbox": null,
        "isPrivateData": false,
        "executionMode": null,
        "creatorClientId": "gui",
        "executorClientId": "gui",
        "importedAt": null,
        "secondsPerLabelDoc": 60,
        "taurusRemoteControlProperties": null,
        "labelsCollectionSuffix": "_17_12",
        "locations": [
            "us-east-1"
        ],
        "scenariosMapping": [
            {
                "id": "f7cebdaa474a27fc93dcff0fd3d97bd116c1f867a6f17639f0fc197eec1f4e5a",
                "name": "default-scenario-1234567",
                "test": "New Dummy Test V4 2",
                "isEndUserExperience": false
            },
            {
                "id": "420248ab89308dba84fc4c15c70f537cdfc938ff4dbe1dd83a7bfe2be32d2a1a",
                "name": "default-scenario-2345678",
                "test": "Parallel Controller Script V4",
                "isEndUserExperience": false
            }
        ],
        "isDebugRun": false,
        "executions": [
            {
                "concurrency": 20,
                "holdFor": "19m",
                "rampUp": "1m",
                "steps": 0,
                "locations": {
                    "us-east-1": 20
                },
                "locationsPercents": {
                    "us-east-1": 100
                },
                "executor": "jmeter",
                "testId": 1234567,
                "scenario": "default-scenario-1234567"
            },
            {
                "concurrency": 20,
                "holdFor": "19m",
                "rampUp": "1m",
                "steps": 0,
                "locations": {
                    "us-east-1": 20
                },
                "locationsPercents": {
                    "us-east-1": 100
                },
                "executor": "jmeter",
                "testId": 2345678,
                "scenario": "default-scenario-2345678"
            }
        ],
        "concurrency": 40,
        "useV4Pipeline": true,
        "terminatedAt": null,
        "shutdownAt": null,
        "jupyterToken": null,
        "jupyterHeartbeat": null,
        "jupyterHost": null,
        "jupyterPort": null,
        "jupyterNotebook": null,
        "v4IndexerCollection": "{\"execution\":[1],\"execution:1\":[\"r-v4-5c828f01e093c\",\"r-v4-5c828f01e6d6d\"],\"session:1\":[\"r-v4-5c828f01e093c\",\"r-v4-5c828f01e6d6d\"],\"location:1\":[\"us-east-1\"]}",
        "buildId": null,
        "isSelenium": false,
        "isExternal": null,
        "rpsCompatible": false,
        "remoteControlCompatible": false,
        "hasMonitoringData": null,
        "shouldSendReportEmail": true,
        "hasDaggerData": false,
        "kinesisStream": "prod-grn_v4pipeline_input",
        "properties": null,
        "created": 1552060161,
        "updated": 1552060161,
        "note": null,
        "testCollectionId": 12345678,
        "testId": null,
        "projectId": 123456,
        "scheduleHistoryRecordId": null,
        "jupyterShipId": null,
        "sessionsId": [
            "r-v4-5c828f01e093c",
            "r-v4-5c828f01e6d6d"
        ],
        "functionalSummary": null,
        "thresholds": [
            {
                "thresholds": [],
                "ignoreRampup": false,
                "ignoreRampupTime": null,
                "slidingWindow": false,
                "testId": 1234567
            },
            {
                "thresholds": [],
                "ignoreRampup": false,
                "ignoreRampupTime": null,
                "slidingWindow": false,
                "testId": 2345678
            }
        ]
    }
}