analytics

Add an annotation

Marks a day, or a range when endsOn is given, with a note of up to 200 characters and one to ten tags. With reportId it shows on that report only; without, on every chart in the project whose dates cover it.

post/v1/projects/{projectId}/annotations

Request

  • Base URL: https://api.prodantix.com
  • URL: https://api.prodantix.com/v1/projects/{projectId}/annotations
  • Auth: HTTP bearer

Path parameters

projectIdstring required

The project the annotations belong to

Request body

reportIdstring nullable
startsOnstring required
endsOnstring nullable
textstring required
tagsstring[] required

Response

The annotation as stored

idstring required
reportIdstring nullable
startsOnstring required
endsOnstring required
textstring required
tagsstring[] required
createdByNamestring nullable
createdAtstring required
updatedAtstring required
canChangeboolean required

Changes

No recorded changes to this operation across all 1 revision of this API.