Load Testing API

• Load Test Administration

  • List Methods
  • Expand Methods

  • GETEcho Message/load/1.0/echo/:message
    Echos a message back to the API caller.
    
    

    Input Variables:

    URL Variable	Value
    message

    
    
    
  • GETWho Am I/load/1.0/whoami
    Retrieves the username associated with the credentials used to issue the API call.
    
    
    

    Output Variables:

    Variable	Possible Values	Description
    username	string	The username associated with the API credentials

    
    
  • GETGet List of Load Tests as a JSONP result/load/1.0/list/mostRecent
    Retrieves a list of recent load tests ordered by date in descending order.
    
    

    Input Variables:

    
    

    Parameter	Value	Type	Description
    limit		int	The maximum number of load tests to retrieve
    callback		string	The name of a javascript function to be called when the JSONP result is received

    
    

    Output Variables:

    Variable	Possible Values	Description
    id	long	The ID of the load test
    accountId	string	The ID of the account that owns the load test
    start	ISO 8601 Date	The scheduled start time of the load test
    end	ISO 8601 Date	The scheduled end time of the load test
    name	string	The name of the load test
    collectorId	string	The ID of the load test collector. Primarily used for interal purposes but it also serves as the unique value in the publicly shareable link to view the load test
    description	string	The description of the load test
    state	SCHEDULED | STAGING_COLLECTOR | STAGING_AGENTS | RUNNING | PAUSED | CLEANING_UP | STOPPED | ABORTED | FINISHED | FAILED | DELETED	An enumeration of states that the load test can be in
    region	US_EAST | US_WEST | EU_WEST | AP_SOUTHEAST | AP_NORTHEAST | SAO_PAULO | OREGON	The geographical region where the source of traffic will be generated from

    
    
  • GETGet List of Load Tests/load/1.0/list
    Retrieves a list of recent load tests ordered by date in descending order.
    
    

    Input Variables:

    
    

    Parameter	Value	Type	Description
    limit		int	The maximum number of load tests to retrieve

    
    

    Output Variables:

    Variable	Possible Values	Description
    id	long	The ID of the load test
    collectorId	string	The ID of the load test collector. Primarily used for interal purposes but it also serves as the unique value in the publicly shareable link to view the load test
    name	string	The name of the load test
    email	string	The email of the user who created the load test
    username	string	The username of the user who scheduled the load test
    description	string	The description of the load test
    paid	boolean	Indicates that the load test has been paid for
    start	ISO 8601 Date	The scheduled start time of the load test
    end	ISO 8601 Date	The scheduled end time of the load test
    state	SCHEDULED | STAGING_COLLECTOR | STAGING_AGENTS | RUNNING | PAUSED | CLEANING_UP | STOPPED | ABORTED | FINISHED | FAILED | DELETED	An enumeration of states that the load test can be in
    queryState	READY | STARTING_UP | NOT_READY	Indicates whether the raw data query service for this load test is active and serving requests
    queryExpiration	ISO 8601 Date	If the query state is READY, then this field indicates the time when the query service will shutdown
    region	US_EAST | US_WEST | EU_WEST | AP_SOUTHEAST | AP_NORTHEAST | SAO_PAULO | OREGON	The geographical region where the source of traffic will be generated from
    tags	array	An array of tag objects.
    delayedStart	boolean	Indicates that the load test started later than it was scheduled to start
    annotations	array	Annotations that have been added to the Load Test Overview graph through the UI
    migratedFromBrowserMob	boolean	Indicates that the load test was migrated to WPM from BrowserMob
    testType	RealBrowserUser | VirtualUser | Undetermined	Indicates the type of scripts used in the test script (they will all be the same type)
    launchedUsers	int	Number of users that where requested for the test. Currently the number of users that were actually provisioned is not available.
    scriptsCount	int	The number of scripts in the test
    partsCount	int	The number of discrete parts in the test plan
    parts	array	An array of objects that represent the discrete parts in the test plan
    scripts	array	An array of objects that represent the scripts in the load test
    uniqueFailures	array	An array of objects that represent script failures that occurred during the load test
    stoppedEarly	boolean	Indicates that the load test was stopped prematurely (usually by a user clicking Stop or Abort in the UI)

    
    
  • PUTAdd Tag/load/1.0/:loadTestId/tag/:tagName
    Add a name tag to a load test
    
    

    Input Variables:

    URL Variable	Value
    loadTestId
    tagName

    
    
    
  • DELETERemove Tag/load/1.0/:loadTestId/tag/:tagName
    Remove a name tag from a load test
    
    

    Input Variables:

    URL Variable	Value
    loadTestId
    tagName

    
    
    
  • GETGet Load Test/load/1.0/id/:loadTestId
    Get a load test by its ID
    
    

    Input Variables:

    URL Variable	Value
    loadTestId

    
    
    

    Output Variables:

    Variable	Possible Values	Description
    id	long	The ID of the load test
    collectorId	string	The ID of the load test collector. Primarily used for interal purposes but it also serves as the unique value in the publicly shareable link to view the load test
    name	string	The name of the load test
    email	string	The email of the user who created the load test
    username	string	The username of the user who scheduled the load test
    description	string	The description of the load test
    paid	boolean	Indicates that the load test has been paid for
    start	ISO 8601 Date	The scheduled start time of the load test
    end	ISO 8601 Date	The scheduled end time of the load test
    state	SCHEDULED | STAGING_COLLECTOR | STAGING_AGENTS | RUNNING | PAUSED | CLEANING_UP | STOPPED | ABORTED | FINISHED | FAILED | DELETED	An enumeration of states that the load test can be in
    queryState	READY | STARTING_UP | NOT_READY	Indicates whether the raw data query service for this load test is active and serving requests
    queryExpiration	ISO 8601 Date	If the query state is READY, then this field indicates the time when the query service will shutdown
    region	US_EAST | US_WEST | EU_WEST | AP_SOUTHEAST | AP_NORTHEAST | SAO_PAULO | OREGON	The geographical region where the source of traffic will be generated from
    tags	array	An array of tag objects.
    delayedStart	boolean	Indicates that the load test started later than it was scheduled to start
    annotations	array	Annotations that have been added to the Load Test Overview graph through the UI
    migratedFromBrowserMob	boolean	Indicates that the load test was migrated to WPM from BrowserMob
    testType	RealBrowserUser | VirtualUser | Undetermined	Indicates the type of scripts used in the test script (they will all be the same type)
    launchedUsers	int	Number of users that where requested for the test. Currently the number of users that were actually provisioned is not available.
    scriptsCount	int	The number of scripts in the test
    partsCount	int	The number of discrete parts in the test plan
    parts	array	An array of objects that represent the discrete parts in the test plan
    scripts	array	An array of objects that represent the scripts in the load test
    uniqueFailures	array	An array of objects that represent script failures that occurred during the load test
    stoppedEarly	boolean	Indicates that the load test was stopped prematurely (usually by a user clicking Stop or Abort in the UI)

    
    
  • DELETEDelete Load Test/load/1.0/:loadTestId/delete
    Deletes a load test
    
    

    Input Variables:

    URL Variable	Value
    loadTestId

    
    
    
  • PUTPause Load Test/load/1.0/:loadTestId/pause
    Pause a running load test
    
    

    Input Variables:

    URL Variable	Value
    loadTestId

    
    
    
  • PUTResume Load Test/load/1.0/:loadTestId/resume
    Resume a paused load test
    
    

    Input Variables:

    URL Variable	Value
    loadTestId

    
    
    
  • POSTSchedule Load Test/load/1.0/schedule
    Schedule a load test
    
    

    Input Variables:

    
    

    Parameter	Value	Type	Description
    name			The name of the load test.
    regions			A single or multiregion loadtests will be executed.An array of region objects where each object look like { "region" : string, "allocation" : int }.Region represents the geographic region where the source of load test traffic will originate from and allocation represents the percentage of users should be used by that particular region.
    start			The date and time when the load test should begin. If this property is not specified, then the load test will be scheduled to start in about 10 minutes. The start date must be at least 10 minutes in the future.
    scripts			An array of scripts that will be executed through the load test. A script object looks as follows: { "percentage" : int, "scriptId" : string }
    overrideCode			The override code that alters the behaviour of the load test. Vercara may provide you with a specific override code depending on your needs.
    parts			The load test plan (represents the number of users in the load test over time). An array of part objects where each part looks as follows { "duration" : int, "maxUsers" : int, "type" : string }. Duration represents number of minutes, maxUsers is the maximum number of users that will execute during this part of the test plan, type is either RAMP (linear increase in number of users over the duration) or CONSTANT (flat).
    browser	CHROMEFF	enumerated	Specifies the browser type that this loadtest should use.

    
    
  • GETTimed out Requests/load/1.0/timeout/:loadTestId
    Get timed out requests
    
    

    Input Variables:

    URL Variable	Value
    loadTestId

    
    

    Parameter	Value	Type	Description
    scriptId		string	The ID of the script
    offset		int	By default the Timed out Requests endpoint returns 50 records. If there are more than 50 records in the request, the offset specifies how many records to skip when displaying the records.

    
    

    Output Variables:

    Variable	Possible Values	Description
    total	long	The count of total requests with loadtestId. If the scriptId is given then total will be the count of total requests with loadtestId and scriptId.
    count	long	The total number of requests.
    loadtestid	long	The ID of the load test
    scriptid	string	The ID of the script
    transactionUrl	string	URL of the timed out transaction request
    exceptionMessage	string	error message for the request
    txid	int	It gives the details of the failed transaction of the particular thread
    stepid	int	The stepid of the request
    timeactive	int	The total time taken for the request
    starttime	ISO 8601 Date	The start time of the request
    endtime	ISO 8601 Date	The end time of the request
    statuscode	boolean	Indicates whether the request is success or not
    id	long	Id of the failed request