# Share a Karate Test Report — API Scenarios on a Link

Canonical: https://commareports.com/share-karate-report
Published: 2026-09-01

> Karate writes an HTML report per run with the full request and response for every step. Publish it to Comma for one URL per suite, threads on individual scenarios, and a revision per run.

# Share a Karate report

Karate's report has the one thing every API test argument needs: the
request that was sent and the response that came back, verbatim, for the
step that failed. Nobody has to reconstruct it or be believed about it.

Which makes it strange that the usual way this evidence travels is
someone pasting four lines of it into a channel.

## Publish it

```bash
mvn test -Dtest=ApiRunner || true

curl -fsS -X PATCH \
  "https://commareports.com/api/v1/reports/$COMMA_REPORT_ID" \
  -H "Authorization: Bearer $COMMA_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d "$(jq -n --rawfile html target/karate-reports/karate-summary.html \
        --arg title "API suite — $ENVIRONMENT — build $BUILD_NUMBER" \
        '{title: $title, html: $html}')"
```

Or drag `target/karate-reports/` into [the app](https://commareports.com/)
so the per-feature pages upload as assets and the summary's links to them
keep working — publishing the summary alone gives you a page whose links
go nowhere.

`|| true` keeps the publish running on a red build. One report id per
suite or per environment; `PATCH` appends a revision per run.

## Mind what is in the log

Karate records request and response bodies, headers included. That is the
value and also the caution: an auth header or a PII-bearing response body
ends up in the report. Reports are **private by default** and access is
per report — keep API-test reports team-visible at most. See the
[sharing model](/docs/sharing), and use a
[scoped token](/docs/api-tokens) with `reports:write` only for the
publish step.

## What the URL changes

- **The API owner gets the evidence, not a summary of it.** Threads
  anchor to the scenario. See [commenting on HTML](/comment-on-html).
- **Environment-by-environment history.** Staging and prod smoke runs as
  separate report ids with separate trends.
- **Readable without a Maven install** — or a CI login.
- **Scheduled smoke runs.** A [routine](/docs/routines) runs the suite on
  a cron and refreshes the report.

## Limits

- **Entry HTML: 5 MB.** Assets: 25 MB per file, **250 MB and 500 files
  total** — a suite with hundreds of features approaches the file count;
  publish per feature group when it does.
- **Scripts run, sandboxed**: `allow-scripts`, no `allow-same-origin`.
- **60 requests/minute per token.**

## Try it

Comma is free — unlimited reports, unlimited commenters, unlimited
revision history.

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

### Related

- [Cucumber reports](/share-cucumber-report) · [Serenity](/share-serenity-report)
- [Newman / Postman](/share-newman-postman-report) — the other API run worth a URL
- [Gatling](/share-gatling-report) · [Publish from CI](/docs/ci)