To configure the Postman integration, you need to provide an API-Key. This can be created here.
Target
You have to specify the collection to run as target. The collections will be discovered by the extension.
Parameters
Parameter
Description
Default
Estimated duration
As long as you have no timeout in place, the step will run as long as needed. You can set this estimation to size the step in the experiment editor for a better understanding of the time schedule.
30s
Environment ID or Name
(optional) The environment id or name to use. You can put the environment name here or find out your environment id by fetching all environments from the postman api with https://api.getpostman.com/environments?apikey=$apiKey
Environment variables
(optional) Additional environment variables, will be passed to newman with --env-var key=value
Iterations
(optional) Number of iterations to run the collection, will be passed to newman with -n
1
Timeout
(optional) The timeout of your collection, wil be passed to newman with --timeout. Hint: If you hit this timeout, no reports will be generated.
Request Timeout
(optional) The request timeout for each request, wil be passed to newman with --timeout-request
Verbose
(optional) Should we enable verbose logging? Will be passed to newman with --verbose
Bail
(optional) Stops the runner when a test case fails. Will be passed to newman with --bail
Outputs
We are using the reporters cli, json-summary and htmlextra.
You can download the json-summary and htmlextra -report in the experiment run log after the experiment has finished. We omit the response bodies in the htmlextra-report.
The cli-output can be accessed by clicking on the Action Logs-tab in the experiment run view and supports a live view during experiment execution.
The step will be marked as failed, if implemented tests in the postman collection are failing.