DEdefra
Benchmark

Start a benchmark run

Changed on

Starts a benchmark run with the supplied (or default) configuration. The run executes in the background; poll GET /api/benchmark/status and GET /api/benchmark/report for progress and results. Creates temporary _benchmark_* collections that are cleaned up automatically on completion or cancellation.

post/benchmark/start

Request

  • Base URL
    /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/benchmark/start
  • Auth
    API key in header X-API-Key

Request body

seedCountinteger

Number of deterministic seed records to create.

concurrencyinteger

Maximum degree of parallelism for scenario execution.

durationstring

Total benchmark duration (TimeSpan format, e.g. '00:03:00'). Scenarios loop until this elapses.

throttleDelaystring

Delay injected between every Mongo operation (TimeSpan format, e.g. '00:00:00.010').

collectionPrefixstring

Prefix applied to all temporary benchmark collections.

Response

Benchmark started

messagestring

Changes