The Performance 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

  • lastRunTimeinteger

    The time the test was last ran

  • namestring

    required

    The test name

  • descriptionstring

    A description of the test

  • userIdinteger

    read-only

    The unique identifier of the user who created the test

  • creatorClientIdstring

    read-only

    The ID of the creator client. For example, api, or gui

  • overrideExecutionsarray

    The test settings used when running the test in BlazeMeter

    • 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

    • 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

    • locationsobject

      The locations where the test will run

      • 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

      • 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

    • 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

    • iterationsinteger

      The number of iterations to run the test with. Will always be 1 for this test type. Same as iterations in Taurus

    • stepsinteger

      The number of rampup steps (same as steps in Taurus). This can be empty

    • throughputinteger

      The maximum throughput allowed (same as throughput in Taurus). This can be empty
      Minimum: 1
      Maximum: concurrency value

  • executionsarray

    The execution settings from the file or last test run for this test

    • 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 locations where the test will run

      • 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

      The percentage of users each location gets

      • 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

    • 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

  • hasThreadGroupsToOverrideboolean

    read-only

    Denotes whether there thread groups (in a JMeter test) to be overriden or not

  • shouldSendReportEmailboolean

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

  • dependenciesobject

    The test data Service Virtualization details to be used with this test.

    • servicesarray

      The list of virtual services to be used in this test

      • 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 Service Data Entities to be used in this virtual service. Service Data is Test Data for virtual services.

      • entitiesarray

        The list of Service Data Entities associated with this virtual service. A Service 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

    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.)

    • typestring

      required

      The test type. Must be taurus.

    • dedicatedIpsEnabledboolean

      Use dedicated IPs for test. Must have dedicated IPs for ALL locations configured.

    • javaVersionstring

      Sets the Java version for the test. ONLY works for JMeter tests. Valid values:
      1.7
      1.8
      9
      11

    • canControlRampupboolean

      read-only

      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

      read-only

      The target number of threads. For example: 500

    • executionTypestring

      read-only

      This is the execution BlazeMeter uses to run the test. Always will be taurusCloud

    • enableJMeterPropertiesboolean

      Enables the JMeter Properties plugin

    • enableHostsOverrideboolean

      Enables the Hosts Override plugin

    • enableFailureCriteriaboolean

      Enables the Failure Criteria plugin

    • enableNetworkEmulationboolean

      Enables the Network Emulation plugin

    • enableMockServicesboolean

      Enables the Service Virtualization plugin

    • scriptTypestring

      required

      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. For example, 250.
      Minimum: 1
      Maximum: 1000 OR plan limit

    • filenamestring

      required

      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

      required

      The test mode this test will use. Can be the following values:
      script - Use when uploading your own script (i.e. Taurus YAML configuration, JMeter script, etc.)
      http - Used for URL tests in BlazeMeter

    • pluginsobject

      Contains settings for shared folders, JMeter properties, and DNS overrides

      • remoteControlarray

        The list of JMeter properties details

        • keystring

          The JMeter property name that is referenced in your JMeter script. ONLY available with JMeter tests

        • valuestring

          The value you want to use in the JMeter propery. ONLY available with JMeter tests

      • hostsarray

        The list of DNS override details

        • hostnamestring

          The host IP or DNS (i.e. my.hostname.com)

        • ipstring

          The host IP/DNS override (i.e. 127.0.0.1)

      • newrelicarray

        The list of New Relic profileIds added to this test

      • sharedFoldersarray

        List of folderIds to be included

      • jmeterobject

        The JMeter version details

        • versionstring

          Set the JMeter version. Valid values:
          auto
          5.1
          5.0
          4.0
          3.3
          3.2
          3.1
          3.0
          2.13

      • networkobject

        The network emulation details

        • presetstring

          The name of this network emulation profile, if one of the preset configurations. Valid values:
          Custom
          Internet (Unlimited)
          WiFi
          3G-good
          3G-normal
          3G-poor
          LTE
          Cable
          DSL
          Edge-good
          Edge-normal
          Edge-poor

        • latencyinteger

          The network delay to simulate in milliseconds (customizable only for Custom preset value). For example, 1050. Minimum: 0 Maximum: 5000

        • bandwidthinteger

          The network speed to simulate in kbps (customizable only for Custom preset value). For example, 202703. Minimum: 0 Maximum: 300000

        • packetlossinteger

          The percent of packet loss to simulate (customizable only for Custom preset value). For example, 24. Minimum: 0, maximum: 100

      • thresholdsobject

        The list of failure criteria set

        • thresholdsarray

          The failure criteria deatils

          • fieldstring

            The failure criteria field title. For example, responseTime.min. Valid values:
            responseTime.avg
            responseTime.percentile.0
            responseTime.percentile.50
            responseTime.percentile.90
            responseTime.percentile.95
            responseTime.percentile.99
            responseTime.min
            responseTime.max
            responseTime.std
            connectTime.avg
            latency.avg
            size.count
            size.avg
            size.rate
            hit.count
            hits.avg
            hits.rate
            duration.count
            errors.count
            errors.percent
            errors.rate

          • labelstring

            The label relevant to failure criteria. Specify ALL for all labels

          • opstring

            The operation is used when checking the failure criteria against the real value. Includes: eq (equal), gt (greater than), lt (less than), ne (not equal)

          • stopTestOnViolationboolean

            Whether to terminate the test if the failure criteria rule has failed. Default: false. Must have slidingWindow set to true to use

          • valuestring

            The failure criteria to check against. For example, 111. Times are in milliseconds (ms)

          • isEmptyboolean

            Denotes if this is an empty failure criteria or not

        • ignoreRampupboolean

          Whether to ignore failure criteria during rampup. Default: false. Must have slidingWindow set to true to use

        • slidingWindowboolean

          Whether to run failure criteria checks using a sliding window of one minute. Default: false

      • dynaTraceobject

        The profile details for the DynaTrace APM integration

        • enabledboolean

          Denotes if the DynaTrace APM is enabled or not

        • methodstring

          Signifies if this integration is using headers or the full integration. Possible values are as follows:
          headers
          fullIntegration

        • profilesarray

          The list of DynaTrace profileIds added to this test

      • cloudWatchobject

        The CloudWatch APM integration profile details

        • newIntegrationboolean

          Denotes if this is a new integration or not

        • profilesarray

          The list of CloudWatch profileIds added to this test

      • caApmobject

        The DX APM integration details

        • enabledboolean

          Denotes if this profile is active or not in this test

        • methodstring

          Signifies if this integration is using headers or the full integration. Possible values are as follows:
          headers
          fullIntegration

        • profilesarray

          The list of DX APM profileIds added to this test

      • appDynamicsarray

        The list of AppDynamics profileIds added to this test

      • newRelicInsightsobject

        The New Relic Insights profile details

        • credentialsIdstring

          The for the New Relic Insights integration

        • profilesarray

          The list of New Relic Insights profileIds added to this test

      • userExperienceobject

        The end user experience details

        • enabledboolean

          Denotes if the End User Experience is enabled

        • pagesarray

          The list of pages to be run in the end user experience

          • labelstring

            Label of the URL you a testing

          • urlstring

            URL to be tested

        • scenariosarray

          The list of scenarios details

          • filenamestring

            The filename of the Selenium file

          • scenariostring

            read-only

            Scenario for the file

The Test Object 

{
    "api_version": 4,
    "error": null,
    "result": {
        "id": 1234567,
        "isNewTest": true,
        "lastRunTime": 1598556724,
        "name": "Full Test Example",
        "description": "A Full Test Settings Example",
        "userId": 123456,
        "creatorClientId": "gui",
        "overrideExecutions": [{
            "concurrency": 20,
            "executor": "jmeter",
            "holdFor": "19m",
            "locations": {
                "us-east4-a": 10,
                "us-east1-b": 10
            },
            "locationsPercents": {
                "us-east4-a": 50,
                "us-east1-b": 50
            },
            "rampUp": "1m",
            "steps": 0,
            "throughput": 10
        }],
        "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",
                "executor": "selenium",
                "executionSource": "endUserExperience",
                "scenario": "End User Experience for Full Test Example"
            }
        ],
        "hasThreadGroupsToOverride": false,
        "hasNonRegularThreadGroup": false,
        "shouldSendReportEmail": true,
        "dependencies": {
            "data": [],
            "services": [{
                "service": "BlazeDemo",
                "mock-service": "Entries Virtual Service",
                "mock-service-template": "Blazedemo Entries Template"
            }]
        },
        "created": 1598555261,
        "updated": 1598555574,
        "projectId": 123456,
        "lastUpdatedById": 123456,
        "configuration": {
            "type": "taurus",
            "dedicatedIpsEnabled": true,
            "javaVersion": "11",
            "canControlRampup": false,
            "targetThreads": 500,
            "executionType": "taurusCloud",
            "enableJMeterProperties": true,
            "enableHostsOverride": true,
            "enableFailureCriteria": true,
            "enableNetworkEmulation": true,
            "enableMockServices": true,
            "enableTestData": false,
            "enableLoadConfiguration": true,
            "scriptType": "jmeter",
            "threads": 500,
            "filename": "Dummy.jmx",
            "testMode": "script",
            "extraSlots": 0,
            "plugins": {
                "remoteControl": [{
                    "key": "newProperty",
                    "value": "aValue"
                }],
                "hosts": [{
                    "hostname": "my.hostname.com",
                    "ip": "10.24.25.100"
                }],
                "newrelic": [
                    "5acc544d61a347b23d7b23c9"
                ],
                "jmeter": {
                    "version": "5.3",
                    "consoleArgs": "",
                    "enginesArgs": ""
                },
                "network": {
                    "preset": "Custom",
                    "latency": 30,
                    "bandwidth": 300000,
                    "packetloss": 5
                },
                "thresholds": {
                    "thresholds": [{
                            "field": "responseTime.avg",
                            "label": "ALL",
                            "op": "gt",
                            "stopTestOnViolation": false,
                            "value": "1500",
                            "isEmpty": false
                        },
                        {
                            "field": "responseTime.max",
                            "label": "ALL",
                            "op": "gt",
                            "stopTestOnViolation": true,
                            "value": "3000",
                            "isEmpty": false
                        }
                    ],
                    "ignoreRampup": true,
                    "fromTaurus": false,
                    "slidingWindow": true
                },
                "dynaTrace": {
                    "enabled": true,
                    "method": "fullIntegration",
                    "profiles": [
                        "5abd5d4863cb0e6c5a7b2577"
                    ],
                    "profilesId": null
                },
                "cloudWatch": {
                    "newIntegration": true,
                    "profiles": [
                        "5abd5d8863cb0e6c5a7b2588"
                    ]
                },
                "caApm": {
                    "enabled": true,
                    "method": "fullIntegration",
                    "profiles": [
                        "5abd5d8863cb0e6c5a7b2577"
                    ]
                },
                "appDynamics": [
                    "5acc544d61a347b23d7b43c9"
                ],
                "newRelicInsights": {
                    "credentialsId": "5e93107b5de79a699662d5c4",
                    "profiles": [
                        "5abd5d8863cb0e6c5a7b2775"
                    ]
                },
                "userExperience": {
                    "enabled": true,
                    "pages": [{
                        "label": "Homepage",
                        "url": "https://blazedemo.com"
                    }]
                }
            }
        }
    },
    "request_id": "5f491a49667ae"
}