# Share a Newman / Postman Run Report — One Link Per Collection

Canonical: https://commareports.com/share-newman-postman-report
Published: 2026-08-21

> newman-reporter-htmlextra writes a file only you can open. Publish the collection run to Comma with one curl: a stable URL per collection, comments anchored to the failing request, and a revision per run you can diff.

# Share a Newman / Postman run report

Newman runs the collection and prints a summary table. Add
`newman-reporter-htmlextra` and you get a genuinely nice HTML report — per
request, per assertion, with response bodies and timings.

Then it sits at `newman/report.html` on whichever machine ran it. In CI
it's an artifact zip; locally it's a file you open with `file://` and
attach to a Slack thread. The QA engineer who wants to show a backend
developer that `POST /orders` returns 200 with an empty body has no link to
send.

## The pattern

Run with the JSON reporter so the pipeline has structured output:

```bash
newman run collection.json \
  -e environments/staging.json \
  --reporters cli,json,htmlextra \
  --reporter-json-export newman/run.json \
  --reporter-htmlextra-export newman/report.html
```

Render `run.json` into a digest — request name, method, URL, status,
assertion pass/fail with the failure message, response time — and publish
it with a [scoped token](/docs/api-tokens) (`reports:write` only):

```bash
curl -fsS -X PATCH "https://commareports.com/api/v1/reports/$REPORT_ID" \
  -H "Authorization: Bearer $COMMA_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d "$(jq -n --rawfile html newman/digest.html \
        --arg title "API contract — staging — $(date -u +%Y-%m-%d)" \
        '{title: $title, html: $html}')"
```

One report per collection-and-environment pair. `PATCH` on every run so the
URL in the runbook never goes stale.

## Publish the htmlextra file, or a digest — both work

htmlextra's output is an app: expandable panels, filter toggles, a search
box. That's fine here. Comma stores report HTML verbatim and renders it in
an iframe with `sandbox="allow-scripts"` and no `allow-same-origin`, so the
report's own JavaScript runs — from an opaque origin, with no access to the
app's DOM, cookies or storage. `curl` the file straight up and the controls
still work.

A digest is still worth building when the collection is large, because a
reviewer wants the failing requests, not all 200 of them:

- **Failures first**, with the assertion message and the response body
  excerpt inline. Passing requests collapse into a count.
- **Attach the original.** `report.html` and any large response captures go
  in as [assets](/docs/api) — 25 MB per file, 250 MB per report.
- **Redact before you publish.** Collection runs carry real request and
  response bodies, and sometimes tokens in headers. Strip auth headers from
  the digest and keep the report team-visible rather than public — see the
  [sharing model](/docs/sharing).

## Comments on the request that failed

The digest renders with an anchored comment layer on top. QA highlights the
row for `POST /orders › expects 201` and pins a thread: "this started
failing after the idempotency-key change — is the 200 intentional?" The
backend developer answers on the thread, and it stays attached to that
request as later runs append revisions.

When the same contract breaks again in two months, the previous
conversation is on the page rather than in Slack scrollback. That
mechanism is described in full in
[commenting on an HTML report](/comment-on-html).

## Monitoring, not just CI

A collection run on a schedule is a contract monitor. Point a
[scheduled routine](/features/routines/scheduled-html-reports) at it, or a
cron in your own infrastructure, and PATCH the same report each time:

- The report becomes an always-current status page for the API contract.
- Previous runs stay as diffable revisions.
- A [webhook](/docs/api) on `revision.created` announces each run into
  Slack or Discord — red runs stop being a thing someone has to notice.

## Try it

Comma is free — unlimited reports, unlimited commenters, unlimited revision
history. Publish the next collection run and send the link.

**[Create your first report →](https://commareports.com/)**

### Related

- [Share a Playwright report](/share-playwright-report) — the same shape, browser tests
- [Publish from CI](/docs/ci) — the general pipeline recipe
- [How to share an HTML report](/share-html-report) — the six properties a shared report needs