Badges

Experiment Badges

You can reference an experiment on any external web page using badges. It’s an excellent way to get a link to your experiment and view the status without navigating and logging into the Steadybit platform.\

Example Badge

example.md

Template:
[![{{expermiment-key}}](https://platform.steadybit.com/api/experiments/{{experiment-key}}/badge.svg?tenantKey={{tenant-key}})](https://platform.steadybit.com/experiments/{{team-key}}/edit/{{experiment-key}}/executions/?tenant={{tenant-key}}~)

Example:
[![SHOP-61](https://platform.steadybit.com/api/experiments/SHOP-61/badge.svg?tenantKey=demo)](https://platform.steadybit.com/experiments/SHOP/edit/SHOP-61/executions/?tenant=demo~)

example.html

Template: 
<a href="https://platform.steadybit.com/experiments/{{team-key}}/edit/{{experiment-key}}/executions/?tenant={{tenant-key}}~" rel="nofollow"><img alt="{{experiment-key}}" src="https://platform.steadybit.com/api/experiments/{{experiment-key}}/badge.svg?tenantKey={{tenant-key}}" style="max-width: 100%;"></a>

Example
<a href="https://platform.steadybit.com/experiments/SHOP/edit/SHOP-61/executions/?tenant=demo~" rel="nofollow"><img alt="SHOP-61" src="https://platform.steadybit.com/api/experiments/SHOP-61/badge.svg?tenantKey=demo" style="max-width: 100%;"></a>

Badges linked to external references

Experiment Badges always links to an existing experiment. But what if you like to have some kind of external reference? Let's say you have an "INCIDENT-100", you are writing a documentation about it and want to add one or more experiment badges to it. Maybe even before you've actually created. This is where the second kind of badges comes into play.

Example Badge before a experiment is created

Example Badge after a experiment is created

Example Badge after multiple experiments are linked to the external reference

example.md

Template:
[![{{external-reference}}](https://platform.steadybit.com/api/badges/linked-badge.svg?tenantKey=demo&externalReference={{external-reference}})](https://platform.steadybit.com/api/badges/link?tenantKey=demo&externalReference={{external-reference}})

Example:
[![INCIDENT-100](https://platform.steadybit.com/api/badges/linked-badge.svg?tenantKey=demo&externalReference=INCIDENT-100&createCaption=Create%20experiment%20for%20incident%20100)](https://platform.steadybit.com/api/badges/link?tenantKey=demo&externalReference=INCIDENT-100)

example.html

Template: 
<a href='https://platform.steadybit.com/api/badges/link?tenantKey=demo&externalReference={{external-reference}}' target='_blank'><img alt="{{external-reference}}" src='https://platform.steadybit.com/api/badges/linked-badge.svg?tenantKey=demo&externalReference={{external-reference}}'></a>

Example
<a href='https://platform.steadybit.com/api/badges/link?tenantKey=demo&externalReference=INCIDENT-100' target='_blank'><img alt="INCIDENT-100" src='https://platform.steadybit.com/api/badges/linked-badge.svg?tenantKey=demo&externalReference=INCIDENT-100&createCaption=Create%20experiment%20for%20incident%20100'></a>