Annotations

List annotations

Returns annotations for a chart context. Requires website read permission.

post/annotations/list

Request

  • Base URL
    https://api.databuddy.cc
  • URL
    https://api.databuddy.cc/annotations/list
  • Auth
    API key in header x-api-key

Request body

websiteIdstring required
chartType'metrics' required

Response

OK

annotationTypestring required
chartTypestring required
colorstring required
createdAtstring date-time required
createdBystring nullable required
deletedAtstring date-time nullable required
idstring required
isPublicboolean required
tagsstring[] nullable required
textstring required
updatedAtstring date-time required
websiteIdstring required
xEndValuestring date-time nullable required
xValuestring date-time required
yValuenumber nullable required

Changes

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