Skip to content
Baremetrics

Create Annotation

POST https://api.baremetrics.com/v1/annotations

Body

application/json
  • metric string required

    Which metric is this for?

  • annotation string required

    The annotation text

  • date string · date required

    YYYY-MM-DD

  • global boolean required

    Should this show on all graphs?

  • user_id string required

    Who added this annotation?

Responses

200OK
{
  "annotation": {
    "id": "our_unique_id",
    "metric": "mrr",
    "annotation": "New Feature 1",
    "date": "2015-03-31",
    "global": true,
    "user": {
      "id": "user_id",
      "email": "user@baremetrics.com",
      "admin": true,
      "name": "User Name"
    }
  }
}
400Bad Request
{}