Request URL

GET https://api.dotcom-monitor.com/config_api_v1/StressTest/{id}

Get test settings by its id.

Path Parameters

Field Type Required Description
id

string

true

 The unique id of a load test. Refer to StressHistory_Seq_ID to select an id.

Success Response

Example response
{"DevicePlatform":"UserView","PlanType":"DynamicPlan",
"Steps":
  [{"StepType":"Start","UsersOrSpeed":1,"DurationSec":0,"StepRole":"UserInitiated"},
   {"StepType":"Increase","UsersOrSpeed":3,"DurationSec":120,"StepRole":"UserInitiated"},
   {"StepType":"Hold","UsersOrSpeed":0,"DurationSec":300,"StepRole":"UserInitiated"}],
"Status":"Calibrating","ID":1781,"Name":"123 Stress Test 5","UserName":null,
"dynamicCurve_StartUsers":0,"dynamicCurve_MaxUsers":0,"dynamicCurve_MaxTestDuration":0,
"goalBasedCurve_TransactionsGoal":0,"goalBasedCurve_Duration":0,"goalBasedCurve_MaxUsers":0,"goalBasedCurve_StartUsers":0,"goalBasedCurve_AdjustmentRate":0,
"static_MaxUsers":0,"static_TransactionsPerMin":0,
"VUD_UsersPerAgent":8}
Field Type Description
DevicePlatform string The type of a test device.

Example:

"DevicePlatform":"UserView"
PlanType string The type of load curve used in the test:

  •  StaticPlan
  •  DynamicPlan
  •  GoalTransaction

Example:

"PlanType":"Undefined"
Steps LoadStep Curve attributes.

Example:

"Steps":[{"StepType":"Start","UsersOrSpeed":1,..
StepType string The type of the Load Step Curve step:

  • Start
  • Increase
  • Decrease
  • Hold
UsersOrSpeed int The number of virtual users emulated on the step or load ramp-up/down rate.
DurationSec int The time duration set for the step in seconds.
StepRole string The type of the Goal-Based Curve step:

  • UserInitiated
  • GoalTransactionWarmUp
  • GoalTransactionStart
Status string The test execution status:

  • Scheduled
  • SubmittingTestRequest
  • InitializingTest
  • StartingLoadInjectors
  • SendingExecutionPlan
  • Running
  • PreparingReport
  • Cancelling
  • Finished
  • Cancelled

Example:

"Status":"Calibrating"
ID int The test scenario ID.

Example:

"ID":1781
Name string The test scenario name.

Example:

"Name":"My Load Test"
UserName string The name provided upon the test start.

Example:

"UserName":null
dynamicCurve_StartUsers int The starting number of concurrent users to load the site with.

Example:

"dynamicCurve_StartUsers":0
dynamicCurve_MaxUsers int The maximum number of users at a moment.

Example:

"dynamicCurve_MaxUsers" : 0
dynamicCurve_MaxTestDuration int The maximum test duration in minutes.

Example:

"dynamicCurve_MaxTestDuration" : 0
goalBasedCurve_TransactionsGoal int The goal throughput.

Example:

"goalBasedCurve_TransactionsGoal" : 0
goalBasedCurve_Duration int The Goal-Based test duration in minutes.

Example:

"goalBasedCurve_Duration" : 0
goalBasedCurve_MaxUsers int The recommended value for the maximum number of virtual users that can be simulated at one time on the target resource.

Example:

"goalBasedCurve_MaxUsers" : 0
goalBasedCurve_StartUsers int
The recommended number of virtual users to start the test with.
Example:
"oalBasedCurve_StartUsers" : 0
goalBasedCurve_AdjustmentRate int
The rate is used to adjust the test execution scenario and represent the number of executions during the stage.
Example:
"goalBasedCurve_AdjustmentRate" : 0
static_MaxUsers int The number of users actually simulated on the target resource per time interval

Example:

"static_MaxUsers" : 0
static_TransactionsPerMin int The actual number of transactions simulated on the target website per minute at each test iteration.

Example:

"static_TransactionsPerMin" : 0
VUD_UsersPerAgent int
The number of virtual users simulated per Load Injector Server (LI Server).
Example:
"VUD_UsersPerAgent" : 8