The Test Object

The GUI Functional Test Object

All timestamps are in UNIX Epoch time.

Attributes

idinteger
read-only

The unique identifier of the test. This is known as the testId and cannot be modified
isNewTestboolean
read-only

Denotes this is a new test. Always True
namestring
required

The test name
descriptionstring

A description of the test
userIdinteger
read-only

The unique identifier of the user
creatorClientIdstring
read-only

The ID of the creator client. For example, api, if created through an API, or gui, if created thorugh the GUI
overrideExecutionsarray

The test settings used when running the test in BlazeMeter
Show/Hide Child Attributes
- executorstring
  
  The script type you are running (similar to executor in Taurus). Will always be selenium for GUI functional tests
- scenariostring
  
  BlazeMeter scenario reference for this execution
- locationsobject
  
  The locations where the test will run
  Show/Hide Child Attributes
  
  location Idinteger
  
  A location Id is needed to reference the correct location. You can add more locations as key-pair values as needed. The value will be the number of users you want to run on that location. Use this OR locationsPercents data, not both
- capabilitiesobject
  
  The webdriver capabilities to be used with this test
  Show/Hide Child Attributes
  
  browserNamestring
  
  The type of browser you want to use. Can be either chrome, for Chrome, or firefox, for Firefox
  
  browserVersionstring
  
  The browser version you want to use. See the GUI Functional Capabilities section for details on the values that can go into this attribute
  
  blazemeter_videoEnabledboolean
  
  Denotes the GUI test will record a video of the test running
executionsarray
read-only

Current execution settings configured for this test
Show/Hide Child Attributes
- 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
- locationsWeightedboolean
  read-only
  
  Denotes if the values in the locations attribute are weighted values or not (same as locationsWeighted in Taurus)
- executorstring
  read-only
  
  The script type you are running. Includes the following:
  gatling
  grinder
  jmeter
  locust
  pbench
  selenium
  siege
- capabilitiesobject
  read-only
  
  The webdriver capabilities to be used with this test
  Show/Hide Child Attributes
  
  browserNamestring
  read-only
  
  The type of browser you want to use. Can be either chrome, for Chrome, or firefox, for Firefox
  
  browserVersionstring
  read-only
  
  blazemeter_videoEnabledboolean
  read-only
- scenariostring
  read-only
  
  BlazeMeter scenario reference for GUI reports
- locationsobject
  read-only
  
  Location details for this test
  Show/Hide Child Attributes
  
  location Idinteger
  read-only
  
  A location Id is needed to reference the correct location. You can add more locations as key-pair values as needed. The value will be the number of users you want to run on that location. Use this OR locationsPercents data, not both
- 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
shouldSendReportEmailboolean

Sets the box for whether an email is sent upon completion of a test run.
dependenciesobject

The virtual service and test data 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
- dataarray
  
  The list of test data entities to be used in this test
  Show/Hide Child Attributes
  
  entitiesarray
  
  The list of Test Data Entities associated with this test. A Data Entity contains one or more Test Data Objects.
  
  kindstring
  
  The kind of Test Data is "tdm".
  
  typestring
  
  The type of Test Data is "object".
createdinteger
read-only

The time that the test was created
updatedinteger
read-only

The time that the test was last updated
projectIdinteger
required

The projectId to which this test belongs
lastUpdatedByIdinteger
read-only

The ID of the last user that updated the test
configurationobject

The configuration settings for this test
Show/Hide Child Attributes
- typestring
  
  The test type. Must be functionalGui
- dedicatedIpsEnabledboolean
  
  Use dedicated IPs for test (not used in this test type). Must have dedicated IPs for ALL locations configured
- canControlRampupboolean
  
  If the user includes a Concurrency Thread Group in their JMX, this parameter indicates if the feature for pausing and resuming ramp-up is enabled. Not used in this test type
- targetThreadsinteger
  
  The target number of threads (not used in this test type). For example: 500
- enableMockServicesboolean
  
  Denotes if Service Virtualization is enabled or not
- scriptTypestring
  
  The script types available. Includes:
  apiritif
  gatling
  grinder
  jmeter
  locust
  nose
  pbench
  pytest
  robot
  selenium
  siege
  taurus
- filenamestring
  
  The name of the file to start test with. For example, BlazeDemoTest.jmx. Note: You must also upload the file - see Upload or Update Asset Files
- testModestring
  
  The mode this test was made with. Can only be script
- pluginsobject
  
  The plugin details used for this test
  Show/Hide Child Attributes
  
  sharedFoldersarray
  
  List of folderIds to be included

The GUI Functional Test Object

{
    "api_version": 4,
    "error": null,
    "result": {
        "id": 1234567,
        "isNewTest": true,
        "name": "GUI Functional Test",
        "description": "This test uses every GUI Functional test configuration we have.",
        "userId": 123456,
        "creatorClientId": "gui",
        "overrideExecutions": [{
                "executor": "selenium",
                "scenario": "default-scenario",
                "locations": {
                    "harbor-5ab3c64ec8589f914c7b25db": 1
                },
                "capabilities": {
                    "browserName": "chrome",
                    "browserVersion": "69",
                    "blazemeter_videoEnabled": true
                }
            },
            {
                "executor": "selenium",
                "scenario": "default-scenario",
                "locations": {
                    "harbor-5ab3c64ec8589f914c7b25db": 1
                },
                "capabilities": {
                    "browserName": "firefox",
                    "browserVersion": "65",
                    "blazemeter_videoEnabled": true
                }
            }
        ],
        "executions": [{
                "iterations": 1,
                "locationsWeighted": true,
                "executor": "selenium",
                "capabilities": {
                    "browserName": "chrome",
                    "browserVersion": "69",
                    "blazemeter_videoEnabled": true
                },
                "scenario": "demoblaze-Selenium",
                "locations": {
                    "harbor-5ab3c64ec8589f914c7b25db": 1
                },
                "concurrency": 1
            },
            {
                "iterations": 1,
                "locationsWeighted": true,
                "executor": "selenium",
                "capabilities": {
                    "browserName": "firefox",
                    "browserVersion": "65",
                    "blazemeter_videoEnabled": true
                },
                "scenario": "demoblaze-Selenium",
                "locations": {
                    "harbor-5ab3c64ec8589f914c7b25db": 1
                },
                "concurrency": 1
            }
        ],
        "shouldSendReportEmail": false,
        "dependencies": {
		    "data":{
                "schema": "http://blazemeter.com/blazedata/schema",
                "id": "datamodels/testParameters",
                "title": "Test Parameters",
                "description": "",
                "kind": "tdm",
                "type": "object",
                "entities": {
                    "user": {
                        "title": "user",
                        "type": "object",
                        "properties": {
                            "name": { "type": "string" }
                        },
                        "requirements": { "name": "\"John Doe\"" },
                        "targets": {
                            "defaultCsv": {
                                "type": "csv",
                                "file": "user.csv",
                                "isHeadless": false
                            }
                        }
                    }
                }
            },
            "services": [{
                "service": "BlazeDemo",
                "mock-service": "Entries Virtual Service",
                "mock-service-template": "Blazedemo Entries Template"
            }]
        },
        "created": 1592488617,
        "updated": 1592489934,
        "projectId": 123456,
        "lastUpdatedById": 123456,
        "configuration": {
            "type": "functionalGui",
            "dedicatedIpsEnabled": false,
            "canControlRampup": false,
            "targetThreads": 0,
            "enableMockServices": true,
            "scriptType": "taurus",
            "filename": "demoblaze--Selenium.yaml",
            "testMode": "script",
            "extraSlots": 0,
            "plugins": {
                "sharedFolders": [
                    "5e5552e75eed7c2c531142c5"
                ]
            }
        }
    },
    "request_id": "5eeb77dd31348"
}

The API Functional Test Object

Starting February 2022, the API Functional testing feature has been deprecated. Depending on your subscription plan, you may still be able to run existing tests but can no longer create new ones. Please use BlazeMeter API Monitoring to create and run your API Functional Tests going forward.

All timestamps are in UNIX Epoch time.

Attributes

idinteger
read-only

The unique identifier of the test. This is known as the testId and cannot be modified
isNewTestboolean
read-only

Denotes this is a new test. Always True
namestring
required

The test name
descriptionstring

A description of the test
userIdinteger
read-only

The unique identifier of the user
creatorClientIdstring
read-only

The ID of the creator client. For example, api, if created through an API, or gui, if created through the GUI
overrideExecutionsarray

The test settings used when running the test in BlazeMeter
Show/Hide Child Attributes
- executorstring
  
  The script type you are running (similar to executor in Taurus). Includes the following:
  gatling
  grinder
  jmeter
  locust
  pbench
  selenium
  siege
- holdForstring
  
  The length of time the test will run at the peak concurrency (same as hold-for in Taurus). Values can be provided in m (minutes) only
- rampUpstring
  
  The length of time the test will take to ramp-up to full concurrency (same as ramp-up in Taurus). Values can be provided in m (minutes) only
- concurrencyinteger
  
  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
- locationsobject
  
  The locations where the test will run
  Show/Hide Child Attributes
  
  location Idinteger
  
  A location Id is needed to reference the correct location. You can add more locations as key-pair values as needed. The value will be the number of users you want to run on that location. Use this OR locationsPercents data, not both
- locationsPercentsobject
  
  The percentage of users each location gets
  Show/Hide Child Attributes
  
  location Idinteger
  
  A location Id is needed to reference the correct location. You can add more locations as key-pair values as needed. The value will be the percentage of users you want to run on that location. Use this OR locations data, not both
- stepsinteger
  
  The number of rampup steps (same as steps in Taurus). This can be empty
executionsarray
read-only

The execution settings from the file or last test run for this test
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
- holdForstring
  read-only
  
  The length of time the test will run at the peak concurrency (same as hold-for in Taurus)
- 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)
- locationsobject
  read-only
  
  The locations where the test will run
  Show/Hide Child Attributes
  
  location Idinteger
  read-only
  
  A location Id is needed to reference the correct location. You can add more locations as key-pair values as needed. The value will be the number of users you want to run on that location. Use this OR locationsPercents data, not both
- locationsPercentsobject
  read-only
  
  The percentage of users each location gets
  Show/Hide Child Attributes
  
  location Idinteger
  read-only
  
  A location Id is needed to reference the correct location. You can add more locations as key-pair values as needed. The value will be the percentage of users you want to run on that location. Use this OR locations data, not both
- scenariostring
  read-only
  
  BlazeMeter scenario reference for this execution
shouldSendReportEmailboolean

Sets the box for whether an email is sent upon completion of a test run
dependenciesobject

The virtual service 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
createdinteger
read-only

The time that the test was created
updatedinteger
read-only

The time that the test was last updated
projectIdinteger
required

The projectId to which this test belongs
lastUpdatedByIdinteger
read-only

The ID of the last user that updated the test
configurationobject

Contains all the advanced BlazeMeter related configurations (i.e. running file, JMeter properties, etc.)
Show/Hide Child Attributes
- typestring
  
  The test type. Must be functionalApi
- canControlRampupboolean
  
  If the user includes a Concurrency Thread Group in their JMX, this parameter indicates if the feature for pausing and resuming ramp-up is enabled
- targetThreadsinteger
  
  The target number of threads (this has no effect on this test type). For example: 500
- enableHostsOverrideboolean
  
  Enables the Hosts Override plugin
- enableMockServicesboolean
- scriptTypestring
  
  The script types available. Includes:
  apiritif
  gatling
  grinder
  jmeter
  locust
  nose
  pbench
  pytest
  robot
  selenium
  siege
  taurus
- threadsinteger
  
  The number of threads each engine (serversCount) should use (this has no effect on this test type). For example, 250.
  Minimum: 1
  Maximum: 1000 OR plan limit
- filenamestring
  
  The name of the file to start test with. For example, BlazeDemoTest.jmx. Note: You must also upload the file - see Upload or Update Asset Files
- testModestring
  
  The mode this test was made with. Can only be script
- pluginsobject
  
  Contains settings for shared folders, JMeter properties, and DNS overrides
  Show/Hide Child Attributes
  
  hostsarray
  
  Contains an array of DNS override settings
  
  Show/Hide Child Attributes
  
  hostnamestring
  
  The host IP or DNS (i.e. my.hostname.com)
  
  ipstring
  
  The host IP/DNS override (i.e. 127.0.0.1)
  
  sharedFoldersarray
  
  List of folderIds to be included
  
  jmeterobject
  
  JMeter settings for this test
  
  Show/Hide Child Attributes
  
  versionstring
  
  Set the JMeter version. Valid values:
  auto
  5.2.1
  5.1
  5.0
  4.0
  3.3
  3.2
  3.1
  3.0
  2.13

The API Functional Test Object

{
    "api_version": 4,
    "error": null,
    "result": {
        "id": 1234567,
        "isNewTest": true,
        "name": "API Functional Test",
        "description": "This test uses every API Functional test configuration we have.",
        "userId": 123456,
        "creatorClientId": "api",
        "overrideExecutions": [{
            "executor": "",
            "holdFor": "19m",
            "rampUp": "1m",
            "concurrency": 20,
            "locations": {
                "us-east4-a": 20
            },
            "locationsPercents": {
                "us-east4-a": 100
            },
            "steps": 0
        }],
        "executions": [{
            "concurrency": 20,
            "holdFor": "19m",
            "rampUp": "1m",
            "steps": 0,
            "locations": {
                "us-east4-a": 20
            },
            "locationsPercents": {
                "us-east4-a": 100
            },
            "scenario": "default-scenario-1234567"
        }],
        "shouldSendReportEmail": true,
        "dependencies": {
            "services": [{
                "service": "BlazeDemo",
                "mock-service": "Entries Virtual Service",
                "mock-service-template": "Blazedemo Entries Template"
            }]
        },
        "created": 1592489620,
        "updated": 1592489637,
        "projectId": 123456,
        "lastUpdatedById": 123456,
        "configuration": {
            "type": "functionalApi",
            "canControlRampup": false,
            "targetThreads": 500,
            "enableHostsOverride": true,
            "enableMockServices": true,
            "scriptType": "",
            "threads": 500,
            "filename": "demoblaze.yml",
            "testMode": "script",
            "extraSlots": 0,
            "plugins": {
                "hosts": [{
                    "hostname": "my.domain.com",
                    "ip": "10.10.10.10"
                }],
                "sharedFolders": [
                    "5e5552e75eed7c2c531142c5"
                ],
                "jmeter": {
                    "version": "auto"
                }
            }
        }
    },
    "request_id": "5eeb77024fe58"
}

The Test Object

The GUI Functional Test Object

Attributes

`id`integer
read-only

`isNewTest`boolean
read-only

`name`string
required

`description`string

`userId`integer
read-only

`creatorClientId`string
read-only

`overrideExecutions`array

`executions`array
read-only

`shouldSendReportEmail`boolean

`dependencies`object

`created`integer
read-only

`updated`integer
read-only

`projectId`integer
required

`lastUpdatedById`integer
read-only

`configuration`object

The API Functional Test Object

Attributes

`id`integer
read-only

`isNewTest`boolean
read-only

`name`string
required

`description`string

`userId`integer
read-only

`creatorClientId`string
read-only

`overrideExecutions`array

`executions`array
read-only

`shouldSendReportEmail`boolean

`dependencies`object

`created`integer
read-only

`updated`integer
read-only

`projectId`integer
required

`lastUpdatedById`integer
read-only

`configuration`object

The Test Object

The GUI Functional Test Object

Attributes

idinteger read-only

isNewTestboolean read-only

namestring required

descriptionstring

userIdinteger read-only

creatorClientIdstring read-only

overrideExecutionsarray

executorstring

scenariostring

locationsobject

location Idinteger

capabilitiesobject

browserNamestring

browserVersionstring

blazemeter_videoEnabledboolean

executionsarray read-only

iterationsinteger read-only

locationsWeightedboolean read-only

executorstring read-only

capabilitiesobject read-only

browserNamestring read-only

browserVersionstring read-only

blazemeter_videoEnabledboolean read-only

scenariostring read-only

locationsobject read-only

location Idinteger read-only

concurrencyinteger read-only

shouldSendReportEmailboolean

dependenciesobject

servicesarray

servicestring

mock-servicestring

mock-service-templatestring

dataarray

entitiesarray

kindstring

typestring

createdinteger read-only

updatedinteger read-only

projectIdinteger required

lastUpdatedByIdinteger read-only

configurationobject

typestring

dedicatedIpsEnabledboolean

canControlRampupboolean

targetThreadsinteger

enableMockServicesboolean

scriptTypestring

filenamestring

testModestring

pluginsobject

sharedFoldersarray

The API Functional Test Object

Attributes

idinteger read-only

isNewTestboolean read-only

namestring required

descriptionstring

userIdinteger read-only

creatorClientIdstring read-only

overrideExecutionsarray

executorstring

holdForstring

rampUpstring

concurrencyinteger

locationsobject

location Idinteger

locationsPercentsobject

location Idinteger

stepsinteger

executionsarray read-only

concurrencyinteger read-only

holdForstring read-only

rampUpstring read-only

stepsinteger read-only

locationsobject read-only

location Idinteger read-only

`id`integer
read-only

`isNewTest`boolean
read-only

`name`string
required

`description`string

`userId`integer
read-only

`creatorClientId`string
read-only

`overrideExecutions`array

`executor`string

`scenario`string

`locations`object

`location Id`integer

`capabilities`object

`browserName`string

`browserVersion`string

`blazemeter_videoEnabled`boolean

`executions`array
read-only

`iterations`integer
read-only

`locationsWeighted`boolean
read-only

`executor`string
read-only

`capabilities`object
read-only

`browserName`string
read-only

`browserVersion`string
read-only

`blazemeter_videoEnabled`boolean
read-only

`scenario`string
read-only

`locations`object
read-only

`location Id`integer
read-only

`concurrency`integer
read-only

`shouldSendReportEmail`boolean

`dependencies`object

`services`array

`service`string

`mock-service`string

`mock-service-template`string

`data`array

`entities`array

`kind`string

`type`string

`created`integer
read-only

`updated`integer
read-only

`projectId`integer
required

`lastUpdatedById`integer
read-only

`configuration`object

`type`string

`dedicatedIpsEnabled`boolean

`canControlRampup`boolean

`targetThreads`integer

`enableMockServices`boolean

`scriptType`string

`filename`string

`testMode`string

`plugins`object

`sharedFolders`array

`id`integer
read-only

`isNewTest`boolean
read-only

`name`string
required

`description`string

`userId`integer
read-only

`creatorClientId`string
read-only

`overrideExecutions`array

`executor`string

`holdFor`string

`rampUp`string

`concurrency`integer

`locations`object

`location Id`integer

`locationsPercents`object

`location Id`integer

`steps`integer

`executions`array
read-only

`concurrency`integer
read-only

`holdFor`string
read-only

`rampUp`string
read-only

`steps`integer
read-only

`locations`object
read-only

`location Id`integer
read-only

`locationsPercents`object
read-only

`location Id`integer
read-only

`scenario`string
read-only

`shouldSendReportEmail`boolean

`dependencies`object