The Master Object

NOTE: All timestamps are in UNIX Epoch Time.

Attributes

idinteger
read-only

The unique identifier of the master. This is known as the masterId and cannot be modified
namestring
required

The test report name
userIdinteger
read-only

The unique identifier of the user
publicTokenstring

The public token that is added to the report link to share the report. Can be added with the Add a Public Token API
endedinteger
read-only

End time of this master (or test report)
lastUpdateinteger
read-only

Time of last sample of this master (or test report)
delayedStartReadyboolean
read-only

Denotes whether the test run was delayed to sync with other engines
runnerUserIdinteger
read-only

The user ID of the user to run the test
maxUsersinteger
read-only

Maximum concurrency reached
createdinteger
read-only

The time that the test was created
updatedinteger
read-only

The time that the test was last updated
reportStatusstring
read-only

Indicates the ending status of the report. Value can be pass, fail, unset, error, abort, or noData
notestring

Contains notes for the given master
passedboolean
read-only

Denotes whether the test run passed or failed its test criteria. See the Thresholds Statistics section for details
parallelTestsInWorkspaceinteger
read-only

Number of tests running in parallel in the workspace with this test
parallelTestsInAccountinteger
read-only

Number of tests running in parallel in the account with this test
isPrivateDataboolean
read-only

Denotes if the data was generated from Private Cloud instance
creatorClientIdstring
read-only

The ID of the creator client of the test. For example, api, or gui
executorClientIdstring
read-only

The ID of the creator client of the test run (master). For example, api, or gui
secondsPerLabelDocinteger
read-only

Denotes the KPI interval of the reports by default
isDebugRunboolean
read-only

Denotes if this was a Debug test run
locationsarray
read-only

The locations (by location id) where the test ran
scenariosMappingarray
read-only

The list of scenarios tied to this test run
Show/Hide Child Attributes
- idstring
  
  The scenarioId for this specific scenario
- namestring
  
  The name of this scenario
- teststring
  
  Name of the test this scenario is tied to
- isEndUserExperienceboolean
  
  Denotes if this scenario was an end user experience or not
executionsarray

The list of excution details for this test run
Show/Hide Child Attributes
- concurrencyinteger
  read-only
  
  The number of concurrent virtual users simulated to run on this location. For example, 20 will set the test to run with 20 concurrent users. Minimum: 1. Same as concurrency in Taurus
- usersNotConfiguredboolean
  read-only
  
  Denotes if the concurrency override has been set or not
- holdForstring
  read-only
  
  The length of time the test will run at the peak concurrency (same as hold-for in Taurus)
- durationIsNotConfiguredboolean
  read-only
  
  Denotes if the hold-for override has been set or not
- rampUpstring
  read-only
  
  The length of time the test will take to ramp-up to full concurrency (same as ramp-up in Taurus)
- stepsinteger
  read-only
  
  The number of rampup steps (same as steps in Taurus)
- iterationsinteger
  read-only
  
  The number of iterations to run the test with. Will always be 1 for this test type. Same as iterations in Taurus
- throughputinteger
  read-only
  
  The maximum throughput allowed (same as throughput in Taurus)
- locationsobject
  
  The lcoation details for this test run
  Show/Hide Child Attributes
  
  location Idinteger
  read-only
  
  Number of engines a test runs with in the given location Ids
- locationsPercentsobject
  
  The location percentage details for this test run
  Show/Hide Child Attributes
  
  location Idinteger
  read-only
  
  Number of engines a test runs with in the given location Ids
- executorstring
  read-only
  
  The script type you are running. Includes the following:
  gatling
  grinder
  jmeter
  locust
  pbench
  selenium
  siege
- scenariostring
  read-only
  
  BlazeMeter scenario reference for GUI reports
- executionSourcestring
  read-only
  
  Tells BlazeMeter to run the selenium scenario for End User Experience under these settings
isSeleniumboolean
read-only

Denotes if this test ran with Selenium
rpsCompatibleboolean
read-only

Denotes if this test ran with the RPS control feature
remoteControlCompatibleboolean
read-only

Denotes if this test ran with the Remote Control feature
hasDataboolean
read-only

Denotes if this test returned data or not
propertiesarray

The list of JMeter properties used in this test run
Show/Hide Child Attributes
- pairsarray
  
  The list of JMeter properties key-value pairs
  Show/Hide Child Attributes
  
  keystring
  read-only
  
  The JMeter property name
  
  valuestring
  read-only
  
  The JMeter property value
- testIdinteger
  read-only
  
  Denotes the testId tied to the master (or test report)
- locationsarray
  read-only
  
  Contains the location ID(s) the JMeter property was applied to
- scenariosarray
  read-only
  
  Contains the scenarioId(s) the JMeter property was applied to
dependenciesarray

The Service Virtualization details to be used with this test
Show/Hide Child Attributes
- servicesarray
  
  The list of virtual services to be used in this test.
  Show/Hide Child Attributes
  
  servicestring
  
  The name of the virtual service. Use the List Virtual Services API to find the name.
  
  mock-servicestring
  
  The name of the running virtual service instance. Use the List Virtual Services API to find the virtual service.
  
  mock-service-templatestring
  
  The name of the virtual service template. Use the List Virtual Service Templates API to find the template.
testIdinteger
read-only

Denotes if the testId tied to the master (or test report)
testCollectionIdinteger
read-only

Denotes if the collectionId tied to the master (or test report)
projectIdinteger
read-only

Denotes if the projectId the master (or test report) is located
sessionsIdarray
read-only

Contains a list of all the sessionIds assigned to the master (or test report)

Note: When running GET sessions/{sessionId}, you can add withMessages=true parameter to retrieve the messages received on the specific session.
hasErrorsPerIntervalboolean

Denotes if the test run has errors
sessionsarray
read-only

Contains a list of all the sessionIds assigned to the master (or test report)
jetpackLabelsarray

The jetpack (V4) label information
Show/Hide Child Attributes
- idstring
  read-only
  
  Contains the labelId of this session (Main labelId)
- namestring
  read-only
  
  Contains the name of the label attached to the labelId
messagesstring

Includes error messages related to the report.

Note: This attribute only appears when running the API with withMessages=true parameter.

Example response: "messages": [{"_id": 9,"code": "ERROR_MASTER_DEPENDENCY_TIMEOUT","level": "ERROR","message": "Timeout occurred while trying to retrieve Virtual Service Configuration / Test Data. Please try again later.","priority": 4,"logs": false}],
aggregatedMessagesstring

Includes error messages related to the sessions running for this report, with the corresponding sessionIds.

Note: This attribute only appears when running the API with withMessages=true parameter.

Example response: "aggregatedMessages": [ { "sessions": [ "r-v4-62d67e2e860b9398863839" ], "code": "ERROR_SESSION_GENERAL_TAURUS", "level": "ERROR", "message": "An error occurred during execution. Most likely the error was in the test configuration. Please check the bzt.log in the Logs tab to find the issue and fix it before running the test again.", "priority": 1, "logs": true } ]

The Master Object

{
    "api_version": 4,
    "error": null,
    "result": {
        "id": 12345678,
        "name": "Full Test Example",
        "userId": 123456,
        "publicToken": "i4QiExnJ7Sz6RXsmeJWmKGoq4mZEepU9k5ZPSDwnLlQVn8PF19",
        "ended": 1599076624,
        "lastUpdate": 1599075313,
        "delayedStartReady": true,
        "runnerUserId": 123456,
        "charges": [],
        "maxUsers": 20,
        "created": 1599075175,
        "updated": 1599077683,
        "reportStatus": "pass",
        "note": "This is a note",
        "passed": true,
        "parallelTestsInWorkspace": 1,
        "parallelTestsInAccount": 1,
        "isPrivateData": false,
        "creatorClientId": "gui",
        "executorClientId": "gui",
        "secondsPerLabelDoc": 60,
        "labelsCollectionSuffix": "_17_12",
        "isDebugRun": false,
        "locations": [
            "us-east4-a",
            "us-east1-b"
        ],
        "scenariosMapping": [
            {
                "id": "62efbba7487d22dc23663844121493c09a1ac48b71c4a30d6c30cc97610c7ece",
                "name": "default-scenario-1234567",
                "test": "Full Test Example",
                "isEndUserExperience": false
            },
            {
                "id": "a554ead1bb83b8a545cd841054cb3d0cb346b92b0a5b813652002a4d1a6e7485",
                "name": "End User Experience for Full Test Example",
                "test": "Full Test Example",
                "isEndUserExperience": true
            }
        ],
        "executions": [
            {
                "concurrency": 20,
                "usersNotConfigured": false,
                "holdFor": "19m",
                "durationIsNotConfigured": false,
                "rampUp": "1m",
                "steps": 0,
                "throughput": 10,
                "locations": {
                    "us-east4-a": 10,
                    "us-east1-b": 10
                },
                "locationsPercents": {
                    "us-east4-a": 50,
                    "us-east1-b": 50
                },
                "executor": "jmeter",
                "scenario": "default-scenario-1234567"
            },
            {
                "concurrency": 1,
                "holdFor": "1200s",
                "durationIsNotConfigured": false,
                "executor": "selenium",
                "executionSource": "endUserExperience",
                "scenario": "End User Experience for Full Test Example"
            }
        ],
        "useV4Pipeline": true,
        "isSelenium": false,
        "hasMonitoringData": true,
        "rpsCompatible": false,
        "remoteControlCompatible": true,
        "hasDaggerData": true,
        "hasData": true,
        "shouldUseDaggerReport": true,
        "properties": [
            {
                "pairs": [
                    {
                        "key": "newProperty",
                        "value": "aValue"
                    }
                ],
                "testId": 1234567,
                "locations": [
                    "us-east4-a",
                    "us-east1-b"
                ],
                "scenarios": [
                    "62efbba7487d22dc23663844121493c09a1ac48b71c4a30d6c30cc97610c7ece",
                    "a554ead1bb83b8a545cd841054cb3d0cb346b92b0a5b813652002a4d1a6e7485"
                ]
            },
            {
                "pairs": [
                    {
                        "key": "blazemeter.throughput",
                        "value": 10
                    }
                ],
                "locations": [
                    "us-east4-a",
                    "us-east1-b"
                ],
                "scenarios": [
                    "62efbba7487d22dc23663844121493c09a1ac48b71c4a30d6c30cc97610c7ece",
                    "a554ead1bb83b8a545cd841054cb3d0cb346b92b0a5b813652002a4d1a6e7485"
                ]
            }
        ],
        "dependencies": [
            {
                "services": [
                    {
                        "service": "BlazeDemo",
                        "mock-service": "Entries Virtual Service",
                        "mock-service-template": "Blazedemo Entries Template"
                    }
                ]
            }
        ],
        "testId": 1234567,
        "projectId": 123456,
        "sessionsId": [
            "r-v4-5f4ff36807701",
            "r-v4-5f4ff36808873",
            "r-eux-5f4ff36809597"
        ],
        "thumbnailUrl": null,
        "hasErrorsPerInterval": true,
        "sessions": [
            "r-v4-5f4ff36807701",
            "r-v4-5f4ff36808873",
            "r-eux-5f4ff36809597"
        ],
        "jetpackLabels": [
            {
                "id": "5a212f0d83b87585c312053aa3d9356faedcd7c83e2e862856bfab3bb352ddb3",
                "name": "Dummy Sampler 9-4"
            },
            {
                "id": "2c4c77b439900407b286f4eb33b7160d476a16af900ca18a654ad7e061e47217",
                "name": "Dummy Sampler 10-5"
            },
            {
                "id": "99ee3d9fd98eac61d70ba85d8171b972356efa76fe998b762727607bfa44774a",
                "name": "Dummy Sampler 4-5"
            },
            {
                "id": "b5c7aed7cd2a308523e7d2847b7815909e864b2fd9c4ea88b00d35adb2ecdfd7",
                "name": "ALL"
            },
            {
                "id": "426b8776c5aea18236671c2031b79e03e36ae61e9525274ff37c4abd8cbf402a",
                "name": "Dummy Sampler 4-3"
            },
            {
                "id": "de5a49b6043c130e9fd482dfff6e039106c712db6471cf1f41f17b702ae1560b",
                "name": "Dummy Sampler 6-2"
            },
            {
                "id": "868ec8f6c10315c31b1c48a07ce3087f7af4c33cbbca2af9f1137e99a87528ad",
                "name": "Dummy Sampler 10-4"
            },
            {
                "id": "ecaf89656817ae7dd9c8cc7c9124dfe2af0e7ee8b6c72c62731ca597245e6df5",
                "name": "Dummy Sampler 3-4"
            },
            {
                "id": "d26beb176d6172083f44e386db016ffe202064b9473b565dec7faed943579b99",
                "name": "Dummy Sampler 4-4"
            },
            {
                "id": "5421f70a20a4cc21671898f969227cf0f7945d8bb64748fe24e97ad8ee12a4bd",
                "name": "Dummy Sampler 3-3"
            },
            {
                "id": "0f8344b783b59a723f7b49f7ec569f4c0c4fd860bd3ef1cdf5d8ac8f8b1b5cb5",
                "name": "Dummy Sampler 1-4"
            },
            {
                "id": "66c400f522edc78b20cc31742ef1ee72de8e9bd652f119da0a9e619bdcfd5f10",
                "name": "Dummy Sampler 7-2"
            },
            {
                "id": "4e55dd94b0687148f4d3fb819da192caf00af1da9ab4e794922ecee2eb9bcca4",
                "name": "Dummy Sampler 3-5"
            },
            {
                "id": "6a8331f28925eae87d618fa2a7d34044c8a4640e7f08850d0888737d9e79734d",
                "name": "Dummy Sampler 5-5"
            },
            {
                "id": "877e982d386229478e921a65cbbaa84fb1c14e58d5754216372ea07f79fffcce",
                "name": "Dummy Sampler 4-1"
            },
            {
                "id": "c5f2e3537e2b7f2fa204abf63de8bc339036b7eee0f9fcb7168995cf3842a04d",
                "name": "Dummy Sampler 2-5"
            },
            {
                "id": "e934b78602eea603ed22388d47aa3090ec643c8dcd604a1ded0f21e8b97f84d3",
                "name": "Dummy Sampler 5-2"
            },
            {
                "id": "3c62fe114a84758fc274ef77eeda9ba81e0c0de495ff2786da892245ca25d8a4",
                "name": "Dummy Sampler 7-4"
            },
            {
                "id": "76b730928743456b46da5cc919aab783cc9780ee49267ab1ea37af9002c48002",
                "name": "Dummy Sampler 3-1"
            },
            {
                "id": "774a039661eb7bbf98665e4d3d28d897de8287e38c190400d8eae2a81dbead99",
                "name": "Dummy Sampler 9-5"
            },
            {
                "id": "c21cc688dc79cc813588c83720a676308b5713747f01bab1b9ded2729ae87a2e",
                "name": "Dummy Sampler 9-3"
            },
            {
                "id": "0656cd0ee5501a550338a725de214239f39aaa90b30cf9d0231f71a01c8f6a2e",
                "name": "Dummy Sampler 1-2"
            },
            {
                "id": "585ee62293662d8e2c161c2621efe4e4b7d8e7cd8de5d19699ee943fb7e0d4f9",
                "name": "Dummy Sampler 2-2"
            },
            {
                "id": "48fb09b24a0ba3106d2a69267c586cd72b46a6690601cfe981e11dfb364be295",
                "name": "Dummy Sampler 2-4"
            },
            {
                "id": "855c41608c960154b1a940db88eb07a6e2ebd670ae17bcf1c9949089645569b1",
                "name": "Dummy Sampler 7-3"
            },
            {
                "id": "6ee11a45e8d1a5ff876fbdc353222498de95de841cb4ac54e977507fe117ba37",
                "name": "Dummy Sampler 1-5"
            },
            {
                "id": "e1b1583297ba88ea9692c62e653f9e05a117c296d425d28921b0ea0ade936118",
                "name": "Dummy Sampler 2-3"
            },
            {
                "id": "c646927269709fd3d09c9119fcc5b759e9e02ee703d22b8380ef4ed9bdbd1496",
                "name": "Dummy Sampler 5-1"
            },
            {
                "id": "e6ea544605da60c4de5d5d1c3a47a28c532c6c1e4f58c5747def5224b31eb3e9",
                "name": "Dummy Sampler 6-1"
            },
            {
                "id": "0afba9498eb0587a5be28586c9fa0111de1bf3475dbe9618ec75e4f46814de56",
                "name": "Dummy Sampler 2-1"
            },
            {
                "id": "c07913d9d35b4071bbf32ceade632e424e173ba0eb616adf5749f613f5596c87",
                "name": "Dummy Sampler 5-3"
            },
            {
                "id": "04493fa0833a77105483f32fe2a32e1baca420ea9d6cda52e876010f91b2e087",
                "name": "Dummy Sampler 6-3"
            },
            {
                "id": "90a45f6678302659a4ba252cf7169c76663c4a08bd73331b00a6ecd630e8ec03",
                "name": "Dummy Sampler 8-1"
            },
            {
                "id": "a33853e884ae4a2f332974875b8f8f0a4521c8c28112e9910b52680582f72dbb",
                "name": "Dummy Sampler 7-1"
            },
            {
                "id": "cbd50211d966c8460e31be9a0622aa1ef614c10626c86013edee4b8ffe995d63",
                "name": "Dummy Sampler 3-2"
            },
            {
                "id": "6be96150c1e953e08a3a1911d9db6ce1f36946840832ea4d3367c781fd2ac6c0",
                "name": "Dummy Sampler 1-1"
            },
            {
                "id": "503a51d46af9a41c84f14c6c0d58bf93c5f28da66fd71356fa6ccd8cdf062b2e",
                "name": "Dummy Sampler 6-4"
            },
            {
                "id": "482d2e3c84148a2a549ce24722c15ca49b9fbe0a7b8ecfe9b9600f21f47f2f26",
                "name": "Dummy Sampler 5-4"
            },
            {
                "id": "07f8cd6ee5c77a7e8ed1430254f701d6fec3ef0aed713d34816734877b8bc086",
                "name": "Dummy Sampler 4-2"
            },
            {
                "id": "d0dd6e4b1eddc8042df773895be292546b71244763b6dbe5f456888d759a0636",
                "name": "Dummy Sampler 10-2"
            },
            {
                "id": "73aa5e01278dab139d90c1e9aa23c990382944709cceac06d10cd65a4b831d7f",
                "name": "Dummy Sampler 6-5"
            },
            {
                "id": "91132961357b44bcca8cd41ab98e51ea52bb79635a6fbd2ed846793db5327960",
                "name": "Dummy Sampler 8-2"
            },
            {
                "id": "598fe62bc04988ae02ee66948b62ce5cb51aea16cfcd790e398f3b176b125543",
                "name": "Dummy Sampler 8-3"
            },
            {
                "id": "47687360da0c21b9b8c24a330319e5106eb2212f5ef4d93a4f566cb15284cf81",
                "name": "Dummy Sampler 7-5"
            },
            {
                "id": "05370c567029cd96cdd248188806f0f9ea114277ed0ec1fab4b616964dfbba7f",
                "name": "Dummy Sampler 10-3"
            },
            {
                "id": "c013b818a253f344d1109bebece47c68eefb8a09e7614ad6665a53faf52bcc5b",
                "name": "Dummy Sampler 8-4"
            },
            {
                "id": "6db63263206a77caf33733fa38cca9daa3af616ee02fa331cdf4ef08ff07c20c",
                "name": "Dummy Sampler 10-1"
            },
            {
                "id": "8d2c3b33df4519ef590751a725db1ab4f2d8af63f0230ecb8dfa04395b49142c",
                "name": "Dummy Sampler 1-3"
            },
            {
                "id": "ddb1b74c3f9f21baac105072fbd95e879a946f47e23e40d7c00565a99acacd7d",
                "name": "Dummy Sampler 8-5"
            },
            {
                "id": "5322c068c11819ca569e53f83db83ee0c7de04f131f5163d67071cb1697cce49",
                "name": "Dummy Sampler 9-1"
            },
            {
                "id": "778b52e53a9424f23a05b4702455800f338e8990d5cfdf01606ea25eb1d6dcfc",
                "name": "Dummy Sampler 9-2"
            }
        ]
    },
    "request_id": "5f4ffd4318af4"
}

The Master Object

Attributes

idinteger read-only

namestring required

userIdinteger read-only

publicTokenstring

endedinteger read-only

lastUpdateinteger read-only

delayedStartReadyboolean read-only

runnerUserIdinteger read-only

maxUsersinteger read-only

createdinteger read-only

updatedinteger read-only

reportStatusstring read-only

notestring

passedboolean read-only

parallelTestsInWorkspaceinteger read-only

parallelTestsInAccountinteger read-only

isPrivateDataboolean read-only

creatorClientIdstring read-only

executorClientIdstring read-only

secondsPerLabelDocinteger read-only

isDebugRunboolean read-only

locationsarray read-only

scenariosMappingarray read-only

idstring

namestring

teststring

isEndUserExperienceboolean

executionsarray

concurrencyinteger read-only

usersNotConfiguredboolean read-only

holdForstring read-only

durationIsNotConfiguredboolean read-only

rampUpstring read-only

stepsinteger read-only

iterationsinteger read-only

throughputinteger read-only

locationsobject

location Idinteger read-only

locationsPercentsobject

location Idinteger read-only

executorstring read-only

scenariostring read-only

executionSourcestring read-only

isSeleniumboolean read-only

rpsCompatibleboolean read-only

remoteControlCompatibleboolean read-only

hasDataboolean read-only

propertiesarray

pairsarray

keystring read-only

valuestring read-only

testIdinteger read-only

locationsarray read-only

scenariosarray read-only

dependenciesarray

servicesarray

servicestring

mock-servicestring

mock-service-templatestring

testIdinteger read-only

testCollectionIdinteger read-only

projectIdinteger read-only

sessionsIdarray read-only

hasErrorsPerIntervalboolean

sessionsarray read-only

jetpackLabelsarray

idstring read-only

namestring read-only

messagesstring

aggregatedMessagesstring

`id`integer
read-only

`name`string
required

`userId`integer
read-only

`publicToken`string

`ended`integer
read-only

`lastUpdate`integer
read-only

`delayedStartReady`boolean
read-only

`runnerUserId`integer
read-only

`maxUsers`integer
read-only

`created`integer
read-only

`updated`integer
read-only

`reportStatus`string
read-only

`note`string

`passed`boolean
read-only

`parallelTestsInWorkspace`integer
read-only

`parallelTestsInAccount`integer
read-only

`isPrivateData`boolean
read-only

`creatorClientId`string
read-only

`executorClientId`string
read-only

`secondsPerLabelDoc`integer
read-only

`isDebugRun`boolean
read-only

`locations`array
read-only

`scenariosMapping`array
read-only

`id`string

`name`string

`test`string

`isEndUserExperience`boolean

`executions`array

`concurrency`integer
read-only

`usersNotConfigured`boolean
read-only

`holdFor`string
read-only

`durationIsNotConfigured`boolean
read-only

`rampUp`string
read-only

`steps`integer
read-only

`iterations`integer
read-only

`throughput`integer
read-only

`locations`object

`location Id`integer
read-only

`locationsPercents`object

`location Id`integer
read-only

`executor`string
read-only

`scenario`string
read-only

`executionSource`string
read-only

`isSelenium`boolean
read-only

`rpsCompatible`boolean
read-only

`remoteControlCompatible`boolean
read-only

`hasData`boolean
read-only

`properties`array

`pairs`array

`key`string
read-only

`value`string
read-only

`testId`integer
read-only

`locations`array
read-only

`scenarios`array
read-only

`dependencies`array

`services`array

`service`string

`mock-service`string

`mock-service-template`string

`testId`integer
read-only

`testCollectionId`integer
read-only

`projectId`integer
read-only

`sessionsId`array
read-only

`hasErrorsPerInterval`boolean

`sessions`array
read-only

`jetpackLabels`array

`id`string
read-only

`name`string
read-only

`messages`string

`aggregatedMessages`string