API Explorer: /masters

To obtain a list of all masters (containing every masterId for a test), use the testId and the /masters endpoint. The sample code returns masters with a testId of 1234567. Use the actual testId in place of the 1234567. The response shown includes one masterId ("id": 12345678). Any additional runs of the testId (every masterId) will also be returned in the response.

You can also obtain a masterId by capturing the id in the response from Start a Test.

curl 'https://a.blazemeter.com/api/v4/masters?testId=1234567' \
	--user 'api_key_id:api_key_secret'
				

List Masters Parameters

All timestamps are in UNIX Epoch time.

Parameters

• projectIdinteger

  The projectId you are wanting to get the list of masters from

• workspaceIdinteger

  The workspaceId you are wanting to get the list of masters from

• testIdinteger

  The testId you are wanting to get the list of masters from

• namestring

  The unique string for a test suite name to search for. For example, the string My Test will pull all results with this string in the name of the multi test

• collectionIdinteger

  The collectionId you are wanting to get the list of masters from

• passedboolean

  Denotes is the test passed or failed based on the test failure criteria set

• startTimeinteger

  The start time (using a timestamp) for which to search for masters (i.e. finding masters that ran after May 1, 2020 is timestamp 1588377599)

• endTimeinteger

  The end time (using a timestamp) for which to search for masters (i.e. finding masters that ran before May 1, 2020 is timestamp 1588291200)

• includeDebugRunsboolean

  Denotes if you want to include any debug masters or not

• platformstring

  Points to the platform you want masters from. Will always be peformance for Performance tests

• locationsstring

  Searches for masters with the given location Id

Also see: Pagination and Sorting

List Masters Response Attributes

See the Master Object for a detailed breakdown of the master object.

Response200 OK

{
    "limit": 10,
    "skip": 0,
    "total": 1,
    "hidden": 0,
    "api_version": 4,
    "error": null,
    "result": [
        {
            "id": 12345678,
            "name": "V4 Remote Control Test",
            "userId": 123456,
            "ended": 1551721953,
            "delayedStartReady": false,
            "runnerUserId": 123456,
            "charges": [],
            "maxUsers": 20,
            "created": 1551721720,
            "updated": 1551721954,
            "passed": true,
            "parallelTestsInWorkspace": 1,
            "parallelTestsInAccount": 1,
            "isPrivateData": false,
            "creatorClientId": "gui",
            "executorClientId": "api",
            "secondsPerLabelDoc": 60,
            "labelsCollectionSuffix": "_17_12",
            "isDebugRun": false,
            "locations": [
                "us-east-1"
            ],
            "scenariosMapping": [
                {
                    "id": "7955907f886baf352a5dd51d04f91b5c209e9af71fb2f035a785614601f3ffd7",
                    "name": "default-scenario-6606270",
                    "test": null,
                    "isEndUserExperience": false
                }
            ],
            "executions": [
                {
                    "concurrency": 20,
                    "holdFor": "19m",
                    "rampUp": "1m",
                    "steps": 0,
                    "throughput": 5,
                    "locations": {
                        "us-east-1": 20
                    },
                    "locationsPercents": {
                        "us-east-1": 100
                    },
                    "executor": "jmeter",
                    "scenario": "default-scenario-6606270"
                }
            ],
            "useV4Pipeline": true,
            "shutdownAt": 1551721933,
            "isSelenium": false,
            "hasMonitoringData": true,
            "rpsCompatible": true,
            "remoteControlCompatible": true,
            "hasDaggerData": true,
            "properties": [
                {
                    "pairs": [
                        {
                            "key": "SampleName",
                            "value": "MySampler1"
                        }
                    ],
                    "testId": 1234567,
                    "locations": [
                        "us-east-1"
                    ],
                    "scenarios": [
                        "7955907f886baf352a5dd51d04f91b5c209e9af71fb2f035a785614601f3ffd7"
                    ]
                },
                {
                    "pairs": [
                        {
                            "key": "blazemeter.throughput",
                            "value": 5
                        }
                    ],
                    "testId": 1234567,
                    "locations": [
                        "us-east-1"
                    ],
                    "scenarios": [
                        "7955907f886baf352a5dd51d04f91b5c209e9af71fb2f035a785614601f3ffd7"
                    ]
                }
            ],
            "testId": 1234567,
            "projectId": 123456,
            "sessionsId": [
                "r-v4-5c7d64f8c95cf"
            ]
        }
    ]
}