How to Add a Bencher Status Badge
A Bencher status badge shows whether your project has any active alerts:
Bencher | passingwhen the project has no active alertsBencher | failingwhen the project has at least one active alert
An Alert is generated when a new result crosses a Threshold. An Alert stays active until it is dismissed or silenced. Alerts on an archived Branch, Testbed, or Measure are not counted, the same as on the Alerts tab of your project in the Bencher Console.
Add the Badge to a README
Add this Markdown to your README, where <project> is your project slug or UUID:
To only count the Alerts on one Branch, add the branch query parameter with the Branch name, slug, or UUID.
Likewise, the testbed query parameter only counts the Alerts on one Testbed.
A / in a name may be encoded as %2F, for example ?branch=release%2F1.0.
To link the badge to the Alerts of your project in the Bencher Console:
[](https://bencher.dev/console/projects/<project>/alerts)Bencher Self-Hosted
For Bencher Self-Hosted, use the URL of your own API server:
Private Projects
The badge of a private project requires an API key, and an image in a README cannot send one. Use the badge in a public README only for a public project.
Updates
The badge may be cached for up to 5 minutes, so it updates within about 5 minutes of an Alert being generated or dismissed.