Interface PerformanceTestConfig

An object that enumerates the test configuration parameters.

interface PerformanceTestConfig {
    maxConcurrentRequests: number;
    responseTimeThreshold: number;
    successRateThreshold: number;
    totalDuration: number;
    totalRequests: number;
}

Properties

maxConcurrentRequests: number

The maximum number of concurrent requests the API allows.

responseTimeThreshold: number

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

successRateThreshold: number

The success rate threshold percentage.

totalDuration: number

The total duration of the test in milliseconds.

totalRequests: number

The total number of requests to make during the test.