The Master Object
The GUI Functional Master Object
Attributes
-
idintegerread-only
The unique identifier of the master. This is known as the
masterIdand cannot be modified -
namestringThe test report (master) name
-
userIdintegerread-only
The
userIdof the user to access the API -
publicTokenstringread-only
The public token that is added to the report link to share the report
-
endedintegerread-only
End time of this
master(or test report) -
delayedStartReadybooleanread-only
Denotes whether the test run was delayed to sync with other engines
-
runnerUserIdintegerread-only
The
userIdof the user to run the master -
createdintegerread-only
The time that the master was created
-
updatedintegerread-only
The time that the master was updated
-
passedbooleanread-only
Denotes whether the test run passed or failed its test criteria
-
parallelTestsInWorkspaceintegerread-only
Number of masters running in parallel in the workspace with this master
-
parallelTestsInAccountintegerread-only
Number of masters running in parallel in the account with this master
-
isPrivateDatabooleanread-only
Denotes if the data was generated from Private Cloud instance
-
executionModestringread-only
List of scenarios in test run. Contains a
scenarioIdfor each scenario (found in theidattribute) -
creatorClientIdstringread-only
The ID of the creator client of the test. Can be either of the following:
api- Denotes test was created through the API
gui- Denotes test was created through the GUI -
executorClientIdstringread-only
The ID of the executor client of the test run (master). Can be either of the following:
api- Denotes test was created through the API
gui- Denotes test was created through the GUI -
secondsPerLabelDocintegerread-only
Denotes the per label KPI values in seconds. Not used in API functional tests
-
isDebugRunbooleanread-only
Denotes if this test was run in debug mode. Not applicable to API Functional tests
-
locationsarrayread-only
The list of locations where this master ran
-
scenariosMappingarrayread-only
A list of scenarios tied to this test run
Show/Hide Child Attributes
-
idstringread-only
The
scenarioIdfor this scenario -
namestringread-only
The name of this scenario
-
teststringread-only
The name of the test this scenario is tied to
-
isEndUserExperiencebooleanread-only
Denotes if the End User Experience was used for this test. Not applicable for API Functional tests
-
-
executionsarrayread-only
The execution settings for this test run
Show/Hide Child Attributes
-
concurrencyintegerread-only
The number of concurrent virtual users simulated that ran on this location. For example,
20will set the test to run with 20 concurrent users. Minimum:1. Same asconcurrencyin Taurus. Not applicable with API functional tests -
holdForstringread-only
The length of time the master ran at the peak concurrency (same as
hold-forin Taurus). Not applicable with API functional tests -
locationsobjectread-only
The locations where the master ran
Show/Hide Child Attributes
-
location Idintegerread-only
The
location Idof the location the master ran in. The value is the number of users that ran on that location
-
-
locationsWeightedbooleanread-only
Denotes if the values in the
locationsattribute are weighted values or not (same aslocationsWeightedin Taurus) -
executorstringread-only
The script type you are running (similar to
executorin Taurus). Will always beseleniumfor GUI functional tests -
capabilitiesobjectread-only
The webdriver capabilities to be used with this test
Show/Hide Child Attributes
-
browserNamestringread-only
The type of browser used in the test run. Can be either
chrome, for Chrome, orfirefox, for Firefox -
browserVersionstringread-only
The browser version u8sed in the test run. See the GUI Functional Capabilities section for details on the values that can go into this attribute
-
blazemeter_videoEnabledbooleanread-only
Denotes the GUI test recorded a video of the test run
-
-
scenariostringread-only
BlazeMeter scenario reference for GUI reports
-
-
isSeleniumbooleanread-only
Denotes if this test ran with Selenium
-
rpsCompatiblebooleanread-only
Denotes if this test ran with the RPS control feature. Does not apply to GUI functional tests
-
remoteControlCompatiblebooleanread-only
Denotes if this test ran with the Remote Control feature. Does not apply to GUI functional tests
-
hasDatabooleanread-only
Denotes if this test returned data
-
dependenciesobjectread-only
The virtual service details to be used with this test
Show/Hide Child Attributes
-
servicesarrayread-only
The list of virtual services to be used in this test
Show/Hide Child Attributes
-
servicestringread-only
The name of the virtual service. Use the List Virtual Services API to find the name
-
mock-servicestringread-only
The name of the running Virtual Service instance. Use the List Virtual Services API to find the virtual service.
-
mock-service-templatestringread-only
The name of the virtual service template. Use the List Virtual Service Templates API to find the template
-
-
-
testIdintegerread-only
Denotes if the
testIdtied to themaster(or test report) -
projectIdintegerread-only
Denotes if the
projectIdthemaster(or test report) is located -
sessionsIdarrayread-only
Contains a list of all the
sessionIds assigned to themaster(or test report) -
gridSummaryobjectread-only
The GUI functional test summary details. See the GUI Functional Summary Object Attributes for the full deatils of this section
-
sessionsarrayread-only
List of
sessionIds tied to this test run -
jetpackLabelsarrayread-only
The jetpack (V4) label information. Not used in GUI functional tests
The GUI Functional Master Object
{
"api_version": 4,
"error": null,
"result": {
"id": 27680681,
"name": "API Created GUI Functional Test",
"userId": 344260,
"publicToken": "LzqK6jza6MRvaJG2RwB3WIRzOtQcX8YjAlG4sW4EtxPVTvsTKp",
"ended": 1587477270,
"delayedStartReady": false,
"runnerUserId": 344260,
"charges": [],
"created": 1587477158,
"updated": 1587477575,
"note": "My Note",
"passed": true,
"parallelTestsInWorkspace": 1,
"parallelTestsInAccount": 1,
"isPrivateData": false,
"executionMode": "functional",
"creatorClientId": "gui",
"executorClientId": "gui",
"secondsPerLabelDoc": 60,
"labelsCollectionSuffix": "_17_12",
"isDebugRun": false,
"locations": [
"harbor-5e0e68b9568b27689176f3b4"
],
"scenariosMapping": [
{
"id": "142087c3061a88b9b02284597ff3c836abcb4800a3f8f3c4e2513c5b762eef15",
"name": "Scenario 1",
"test": "April_20_3:28 PM - GUI Functional Test",
"isEndUserExperience": false
}
],
"executions": [
{
"concurrency": 1,
"holdFor": "42720s",
"locations": {
"harbor-5e0e68b9568b27689176f3b4": 1
},
"locationsWeighted": true,
"executor": "selenium",
"capabilities": {
"browserName": "chrome",
"browserVersion": "69",
"blazemeter_videoEnabled": true
},
"scenario": "Scenario 1"
}
],
"useV4Pipeline": false,
"isSelenium": true,
"hasMonitoringData": true,
"rpsCompatible": false,
"remoteControlCompatible": false,
"hasDaggerData": false,
"hasData": true,
"shouldUseDaggerReport": false,
"dependencies": [
[
{
"services": [
{
"service": "BlazeDemo",
"mock-service": "Entries Virtual Service",
"mock-service-template": "Blazedemo Entries Template"
}
]
}
]
],
"testId": 7943742,
"projectId": 573256,
"sessionsId": [
"r-v4-5e9efaa6e8d95",
"r-sg-5e9efab3ca407"
],
"thumbnailUrl": null,
"hasErrorsPerInterval": true,
"gridSummary": {
"uniqueTestCasesCount": 1,
"uniqueSuitesCount": 1,
"passedTestCasesCount": 1,
"failedTestCasesCount": 0,
"brokenTestCasesCount": 0,
"totalTestCasesCount": 1,
"undefinedTestCasesCount": 0,
"testCasesCount": 1,
"passedPercent": 1,
"started": 1587477193,
"ended": 1587477257,
"definedStatus": "passed"
},
"sessions": [
"r-v4-5e9efaa6e8d95",
"r-sg-5e9efab3ca407"
],
"jetpackLabels": []
},
"request_id": "5ef1fadee24e0"
}
The API Functional Master Object
Attributes
-
idintegerread-only
The unique identifier of the master. This is known as the
masterIdand cannot be modified -
namestringThe test report name
-
userIdintegerread-only
The
userIdof the user to access the API -
publicTokenstringread-only
The public token that is added to the report link to share the report
-
endedintegerread-only
End time of this
master(or test report) -
delayedStartReadybooleanread-only
Denotes whether the test run was delayed to sync with other engines
-
runnerUserIdintegerread-only
The
userIdof the user to run the master -
createdintegerread-only
The time that the master was created
-
updatedintegerread-only
The time that the master was updated
-
passedbooleanread-only
Denotes whether the test run passed or failed its test criteria
-
parallelTestsInWorkspaceintegerread-only
Number of tests running in parallel in the workspace with this master
-
parallelTestsInAccountintegerread-only
Number of tests running in parallel in the account with this master
-
isPrivateDatabooleanread-only
Denotes if the data was generated from Private Cloud instance
-
executionModestringread-only
List of scenarios in test run. Contains a
scenarioIdfor each scenario (found in theidattribute) -
creatorClientIdstringread-only
The ID of the creator client of the test. Can be either of the following:
api- Denotes test was created through the API
gui- Denotes test was created through the GUI -
executorClientIdstringread-only
The ID of the executor client of the test run (master). Can be either of the following:
api- Denotes test was created through the API
gui- Denotes test was created through the GUI -
secondsPerLabelDocintegerread-only
Denotes the per label KPI values in seconds. Not used in API functional tests
-
isDebugRunbooleanread-only
Denotes if this test was run in debug mode. Not applicable to API Functional tests
-
locationsarrayread-only
The list of locations where this master ran
-
scenariosMappingarrayread-only
A list of scenarios tied to this test run
Show/Hide Child Attributes
-
idstringread-only
The
scenarioIdfor this scenario -
namestringread-only
The name of this scenario
-
teststringread-only
The name of the test this scenario is tied to
-
isEndUserExperiencebooleanread-only
Denotes if the End User Experience was used for this test. Not applicable for API Functional tests
-
-
executionsarrayread-only
The execution settings for this test run
Show/Hide Child Attributes
-
concurrencyintegerread-only
The number of concurrent virtual users simulated that ran on this location. For example,
20will set the test to run with 20 concurrent users. Minimum:1. Same asconcurrencyin Taurus. Not applicable with API functional tests -
holdForstringread-only
The length of time the master ran at the peak concurrency (same as
hold-forin Taurus). Not applicable with API functional tests -
durationIsNotConfiguredbooleanread-only
Denotes if the test was configured without a duration. Not applicable with API functional tests
-
iterationsintegerread-only
The number of iterations the mastere ran with (same as
iterationsin Taurus) -
locationsobjectread-only
The locations where the master ran
Show/Hide Child Attributes
-
location Idintegerread-only
The
location Idof the location the master ran in. The value is the number of users that ran on that location
-
-
locationsWeightedbooleanread-only
Denotes if the values in the
locationsattribute are weighted values or not (same aslocationsWeightedin Taurus) -
scenariostringread-only
BlazeMeter scenario reference for GUI reports
-
-
isSeleniumbooleanread-only
Denotes if this test ran with Selenium. Not relevant for API functional tests
-
rpsCompatiblebooleanread-only
Denotes if this test ran with the RPS control feature. Does not apply to API functional tests
-
remoteControlCompatiblebooleanread-only
Denotes if this test ran with the Remote Control feature. Does not apply to API functional tests
-
hasDatabooleanread-only
Denotes if this test returned data
-
dependenciesobjectread-only
The virtual service details to be used with this test
Show/Hide Child Attributes
-
servicesarrayread-only
The list of virtual services to be used in this test
Show/Hide Child Attributes
-
servicestringread-only
The name of the virtual service. Use the List Virtual Services API to find the name
-
mock-servicestringread-only
The name of the running virtual service instance. Use the List Virtual Services API to find the virtual service
-
mock-service-templatestringread-only
The name of the virtual service template. Use the List Virtual Service Templates API to find the template
-
-
-
testIdintegerread-only
Denotes if the
testIdtied to themaster(or test report) -
projectIdintegerread-only
Denotes if the
projectIdthemaster(or test report) is located -
sessionsIdarrayread-only
Contains a list of all the
sessionIds assigned to themaster(or test report) -
functionalSummaryobjectread-only
The API functional test summary details. See the API Functional Summary Object Attributes for the full deatils of this section
-
sessionsarrayread-only
List of
sessionIds tied to this test run -
jetpackLabelsarrayread-only
The jetpack (V4) label information. Not used in API functional tests
The API Functional Master Object
{
"api_version": 4,
"error": null,
"result": {
"id": 29329152,
"name": "API Functional Validation Test",
"userId": 344260,
"publicToken": "RUSd9VYDPnIW5SmBWDkqRXeovQ5U0XFtwGCLNikkxgELMGSafl",
"ended": 1592571712,
"delayedStartReady": false,
"runnerUserId": 344260,
"charges": [],
"created": 1592571681,
"updated": 1592572015,
"passed": true,
"parallelTestsInWorkspace": 1,
"parallelTestsInAccount": 1,
"isPrivateData": false,
"executionMode": "functional",
"creatorClientId": "gui",
"executorClientId": "gui",
"secondsPerLabelDoc": 60,
"labelsCollectionSuffix": "_17_12",
"isDebugRun": false,
"locations": [
"harbor-5b0323b3c648be3b4c7b23c8"
],
"scenariosMapping": [
{
"id": "3b72f4fdbd4000b35e51e4d4db89fe2a02ea2f34f504bfd2c069e6de535f4c62",
"name": "My Scenario",
"test": "API Functional Validation Test",
"isEndUserExperience": false
}
],
"executions": [
{
"concurrency": 1,
"holdFor": "42720s",
"durationIsNotConfigured": true,
"iterations": 1,
"locations": {
"harbor-5b0323b3c648be3b4c7b23c8": 1
},
"locationsWeighted": true,
"scenario": "My Scenario"
}
],
"useV4Pipeline": false,
"isSelenium": false,
"hasMonitoringData": true,
"rpsCompatible": false,
"remoteControlCompatible": false,
"hasDaggerData": false,
"hasData": true,
"shouldUseDaggerReport": false,
"dependencies": [
[
{
"services": [
{
"service": "BlazeDemo",
"mock-service": "Entries Virtual Service",
"mock-service-template": "Blazedemo Entries Template"
}
]
}
]
],
"testId": 7895446,
"projectId": 573256,
"sessionsId": [
"r-v4-5eecb721e4da3"
],
"thumbnailUrl": null,
"hasErrorsPerInterval": true,
"functionalSummary": {
"testsCount": 1,
"requestsCount": 1,
"errorsCount": 0,
"assertions": {
"count": 1,
"passed": 1
},
"responseTime": {
"sum": 512
},
"failedCount": 0,
"failedPercentage": 100
},
"sessions": [
"r-v4-5eecb721e4da3"
],
"jetpackLabels": []
},
"request_id": "5ef1fae434412"
}