newman-reporter-postman-cloud

A Newman reporter that uploads newman run summary data back to Postman. This reporter processes the newman run metrics, and then uploads the data to the provided Workspace in Postman.

Once uploaded, you can see your collection runs on Postman Desktop App or on Postman Web.

Install

The reporter works as a plugin with Newman so ensure that you have already installed that package globally, using npm install -g newman.

To globally install the postman cloud reporter:

npm install -g newman-reporter-postman-cloud

Usage

To use this reporter with Newman CLI, specify postman-cloud in Newman's -r or --reporter option.

newman run collection.json -r postman-cloud

CLI Options

| Parameter | Description | Required | |---------------|-----------------|--------------| | --reporter-postman-cloud-apiKey "<apiKey>" | This will be used to authenticate API call to Postman API. You can generate an API Key from here | Yes | | --reporter-postman-cloud-workspaceId "<workspaceId>" | This is the workspace id where you want your collection run to be created in Postman | Yes |

With Newman as a Library

All the CLI functionality is available for programmatic use within a nodejs script.

const newman = require('newman');

newman.run({
  collection: './path/to/collection.json',
  reporters: ['postman-cloud'],
  reporter: {
    'postman-cloud': {
      apiKey: 'apiKey',
      workspaceId: 'workspaceId'
    }
  }
})

Compatibility

| newman-reporter-postman-cloud | newman | node | |-----------------------------------|------------|----------| | >= v1.0.0 | >= v5.3.2 | >= v14.x |

License

This software is licensed under Apache-2.0. See the LICENSE.md file for more information.