Contents

PerformanceTestConfig

An object that enumerates the test configuration parameters.

Declaration

object PerformanceTestConfig

Properties

NameTypeDescription
maxConcurrentRequests Requiredint64

The maximum number of concurrent requests the API allows.

responseTimeThreshold Requiredint64

The maximum time your server has to respond when the system calls your Get Retention Message endpoint in the sandbox environment.

successRateThreshold Requiredint32

The success rate threshold percentage.

totalDuration Requiredint64

The total duration of the test in milliseconds.

totalRequests Requiredinteger

The total number of requests to make during the test.

Overview

The Initiate Performance Test endpoint returns the PerformanceTestConfig object in the PerformanceTestResponse response.

When you call the Initiate Performance Test endpoint to start a performance test, the test sends multiple requests and runs for a period of time. To calculate the time when the test concludes, add the totalDuration to the time, in milliseconds, you initiated the test.

See Also

Performance testing