README
Newman Reporter CSV
Add CSV reports to your Newman runs.
About
Each request in a collection run maps to a row in the outputted CSV file with the following columns:
Column | Description | Example |
---|---|---|
iteration | collection run iteration number | 1 |
collectionName | name of the collection | My fancy API |
requestName | name of the request made | Create user |
method | HTTP method of the request | POST |
url | URL of the request | http://localhost:3000/user/create |
status | response status of the request | OK |
code | response code of the request | 200 |
responseTime | time taken to receive a response (ms) | 56 |
responseSize | size of the response (bytes) | 130 |
executed | tests that passed | Status was 200, User was created |
failed | tests that failed | User has view permissions |
skipped | tests that were skipped | User had first name Joe |
body | the response body | { foo: "bar" } |
Note: test names are comma separated |
body
is optional, see Options
Setup
Ensure you have Newman setup first:
npm install newman --save-dev
Then install this package:
npm install newman-reporter-csv --save-dev
Usage
You can then use the -r csv
option to make Newman use the CSV reporter.
node_modules/.bin/newman run postman_collection.json -e postman_environment.json -r csv
Options
CLI Option | Description |
---|---|
--reporter-csv-export |
Specify a path where the output CSV file will be written to disk. If not specified, the file will be written to newman/ in the current working directory. |
--reporter-csv-includeBody | If you wish to save the response body for each request, use this option. |
node_modules/.bin/newman run postman_collection.json -e postman_environment.json -r csv --reporter-csv-includeBody