API Explorer: /tests

To return a list of created tests, either a projectId or a workspaceId, and a type attribute is required. The sample code returns a list for items with a projectId of 123456 and a workspaceId of 123456 and a type of functionalApi. Use the actual ID values for the project or workspace and one of the type values (should use taurus (performance tests)) to return the list of its tests.. Use the actual ID values for the project or workspace to return the list of its tests.

You can return a list specifying either a projectId, a workspaceId, or both and a type. The returned list contains each test details that fit the criteria provided.

curl 'https://a.blazemeter.com/api/v4/tests?projectId=123456&workspaceId=123456&type=taurus' \
    -H 'Content-Type: application/json' \
    --user 'api_key_id:api_key_secret'

Parameters

• projectId integer

  required

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

• workspaceId integer

  required

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

• name string

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

• platform string

  The platform of tests to search for. This will always be performance for Performance tests

• type string

  Searches by the test type. The following values are for functional:
  taurus - Returns a list of Performance tests=

• hasExecutions boolean

  Shows the list of tests that have (if set to true) or have no (if set to false) masters

Also see: Pagination and Sorting

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

{
    "limit": 10,
    "skip": 0,
    "total": 1,
    "hidden": 0,
    "api_version": 4,
    "error": null,
    "result": [
        {
            "id": 1234567,
            "name": "New Test Name For API Documentation",
            "isNewTest": true,
            "userId": 123456,
            "created": 1551635668,
            "updated": 1551717656,
            "creatorClientId": "api",
            "overrideExecutions": [
                {
                    "executor": "jmeter",
                    "holdFor": "19m",
                    "rampUp": "1m",
                    "concurrency": 20,
                    "locations": {
                        "us-east-1": 20
                    },
                    "locationsPercents": {
                        "us-east-1": 100
                    },
                    "steps": 0
                }
            ],
            "executions": [
                {
                    "concurrency": 20,
                    "holdFor": "19m",
                    "rampUp": "1m",
                    "steps": 0,
                    "locations": {
                        "us-east-1": 20
                    },
                    "locationsPercents": {
                        "us-east-1": 100
                    },
                    "executor": "jmeter",
                    "scenario": "default-scenario-6654357"
                }
            ],
            "shouldSendReportEmail": true,
            "projectId": 123456,
            "lastUpdatedById": 123456,
            "configuration": {
                "type": "taurus",
                "executionType": "taurusCloud",
                "filename": "MyTest.jmx",
                "testMode": "script",
                "scriptType": "jmeter"
            }
        }
    ]
}