Add annotations
The Context Annotations API allows you to programmatically annotate important dates (e.g. feature releases and marketing campaigns).
POST /api/annotation/EVENTSOURCEID
Parameter | Type | Description |
---|---|---|
title required | String | Short text to describe the annotation. |
description | String | Long text to describe the annotation with more details. |
category required | String | It will help you to organize your annotations in meaningful categories. |
url | String | Add a URL with further details about the annotation. |
publishDate | Date (RFC2822 format) | The date when the event described by the annotation took place. If left blank, current date will be used. i.e.: 2018-06-27 . |
Example request
curl --request POST \
--url https://contextapi.sweetlabs.io/api/annotation/ \
--header 'Content-Type: application/json' \
--data '{
"title": "Annotation title",
"category": "My category",
"description": "Annotation body",
"publishDate": "2018-09-11",
"url": "https://www.sweetlabs.io"}'