# `Stampede.Reporter`
[🔗](https://github.com/mandar1045/stampede/blob/v0.2.0/lib/stampede/reporter.ex#L1)

Formats a `Stampede.Result` for the terminal, or as JSON.

# `format`

```elixir
@spec format(Stampede.Result.t()) :: String.t()
```

Returns a summary of `result`, with a line per metric followed by the
checks, the thresholds and the most frequent errors, if there are any.

# `to_json`

```elixir
@spec to_json(Stampede.Result.t()) :: String.t()
```

Returns `result` as JSON, with every metric, the timeline, the thresholds
and the errors.

Timings are in milliseconds and rates per second, as in `Stampede.Result`.

---

*Consult [api-reference.md](api-reference.md) for complete listing*
